cyclus / cyclus/cyclus.github.com
Toolkit page needs an update
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
Cyclus Toolkit page is missing information on
- Material Buy Policy
- Material Sell Policy
- Total Inventory Tracker
- Res Manip
- Timeseries
Buy/Sell policies might warrant their own page linked from within the toolkit page?
Also the archetype development tutorials (C++, python) should probably link to the main toolkit page
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 with source/arche/toolkit.rst and compare the linked source/arche/tutorial_cpp/toolkit.rst and source/arche/tutorial_py/toolkit.rst pages. Add information for Material Buy Policy, Material Sell Policy, Total Inventory Tracker, Res Manip, and Timeseries, deciding whether the buy/sell policies need a separate linked page. Update both tutorials to link to the main toolkit page; the checklist should be complete when all requested information and links are present.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100