cyclus / cyclus/cyclus.github.com
User tutorial data_explorer isn't used
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
The 'source/user/tutorial/data_explorer.rst` isn't used anywhere in the website. It's designed to walk a user through how to parse through the output database, which is potentially useful. However, there are several images that are missing from the repo, and it doesn't use cymetric any. Personally, I think there are two options:
- Redo this page to use cymetric and walk through a sample data analysis
- Remove this page, and put a note on another page that points to the cymetric repo and the examples there.
Any thoughts?
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/user/tutorial/data_explorer.rst and inspect how it is referenced by the website. Check the missing images and compare the tutorial's database-analysis approach with the cymetric repository examples. The issue needs a decision between rewriting the page around cymetric and removing it with a pointer elsewhere before completion can be defined.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100