Skip to content

Commit

Permalink
update docs and rename notebook for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
JostMigenda committed Apr 22, 2024
1 parent 0a851a9 commit d5a8fb4
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion doc/nb/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# SNEWPY Usage Examples

The Jupyter notebooks in this directory contain different examples for how to use SNEWPY. Please see also the example notebooks for each supernova model, which are included in the same directory as the model files when downloading them via `python -c 'import snewpy; snewpy.get_models()'`.
The Jupyter notebooks in this directory contain different examples for how to use SNEWPY.

## `ccsn` and `presn` Directories

These directories contain notebooks demonstrating how to use the core-collapse and pre-supernova models available through SNEWPY.

## AnalyticFluence

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion doc/source/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ This will generate the following figure:
.. image:: luminosity-comparison.*


The SNEWPY repository contains many Jupyter notebooks in ``models/<model-name>/`` or ``doc/nb/`` with sample code
The SNEWPY repository contains many Jupyter notebooks in ``doc/nb/`` with sample code
showing different models or how to apply flavor transformations to the neutrino fluxes.

More advanced usage of SNEWPY requires SNOwGLoBES and is described in the following section.

0 comments on commit d5a8fb4

Please sign in to comment.