cyclus / cyclus/cyclus.github.com

Do we want to add a page about analysis with Cymetric to the end of Exercise 1?

Open
#431 1 comment 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

For the tutorial, do we want to add a a page with some instructions to guide users through analysis of the Cyclus results with Cymetric? We could pull some of the examples that we already have in the cymetric repo. We could add this to any of the input files created in the tutorial.

Alternatively, we do have a set of pages about Cymetric and we can point to that at the end of the tutorial.

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

Read the Exercise 1 tutorial, the input files it creates, and the existing Cymetric pages or examples in the Cymetric repository. Decide whether the tutorial needs standalone analysis instructions or only a link to existing pages; the work is done when Exercise 1 clearly provides one of those paths for analyzing Cyclus results.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.