search

villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

[JOSS Review] Add examples in `example-usecase/Yields_and_Resolutions.ipynb` to docs #87

Open nuclearGoblin opened 2 years ago

nuclearGoblin commented 2 years ago

From the review thread:

The examples in example-usecase/Yields_and_Resolutions.ipynb are nice and it would be great to see these get added into the docs using some of the Jupyter rendering Sphinx extensions.

matthewfeickert commented 2 years ago

From https://github.com/openjournals/joss-reviews/issues/3993#issuecomment-1015075303:

(This is a suggested improvement, but not a change that needs to be made to pass review).

Here I was thinking it would be nice to use something like nbsphinx to render notebooks like Yields_and_Resolutions.ipynb in the docs. c.f. https://docs.readthedocs.io/en/stable/guides/jupyter.html for some examples on getting started.