cyclus / cyclus/cyclus.github.com
Improve documentation for including XML files within each other
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
It is possible to include information from one XML file in another XML file to build a complete input file for Cyclus. This capability has been demonstrated by a few users (e.g. https://github.com/arfc/predicting-the-past/tree/master/cyclus_input) but is not intuitive and should be better documented.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked predicting-the-past/cyclus_input example and the existing Cyclus documentation to identify where XML inclusion is explained. Add a clear explanation of how to include information from one XML file in another, using the example as a reference, and verify that users can follow the documented process to build a complete input file.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100