cyclus / cyclus/cyclus.github.com

Do we want to still have the example of running Cyclus via IPython notebook? Or the intro to the Notebooks?

Open
#430 6 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

Currently, source/user/tutorial/run_cyclus_native.rst there is an intro to jupyter notebooks. Do we want to keep this intro and walking through running Cyclus in a jupyter notebook, or do we want to move everything to the command line?

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 by reading source/user/tutorial/run_cyclus_native.rst, especially its Jupyter notebook introduction and Cyclus walkthrough. Review the surrounding tutorial structure and decide whether the notebook material should remain or move to command-line instructions. Done means the documentation direction is agreed and the affected tutorial content reflects that decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.