cyclus / cyclus/cyclus.github.com

In the institution block we talk about the `lifetime`, which applies to the facilities. Do we want to move this somewhere else? Add it to the second scenario as a more advanced concept.

Open
#429 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
33
PR merge metrics
No merged PRs in 30d

Description

Sub-issue of #427 that I felt needed more discussion.

in source/user/tutorial/add_reg_inst.rst we talk about the lifetime input with the institutions (see the Concept: Institutions section). We talk about the name, lifetime, config, and initialfacilitylist section. The last one is unique to institutions, but the others apply to the facility prototype definition sections (which are discussed before institutions) and regions. Therefore, it feels weird to me for us to wait so long to explicitly call out those tags.

Should we add a page just talking about the general format/structure of an input file? Any other ideas on how to reconcile this disconnect?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with source/user/tutorial/add_reg_inst.rst, especially the Concept: Institutions section and its discussion of name, lifetime, config, and initialfacilitylist. Review the related material for facility prototype definitions and regions, then resolve where the general input-file structure or lifetime guidance belongs. Done means the documentation has a clear, agreed explanation without duplicating or delaying these concepts.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.