search

SNEWS2 / snewpy

A Python package for working with supernova neutrinos
https://snewpy.readthedocs.io
BSD 3-Clause "New" or "Revised" License
24 stars 17 forks source link

clean up model notebooks and documentation #288

Closed sybenzvi closed 2 months ago

sybenzvi commented 8 months ago

We are factoring the snewpy repo into code that lives here and model files that live in snewpy-models-ccsn. Currently the jupyter notebooks which demonstrate the models live in the folder

snewpy/models/{model_name}/{model_name}.ipynb

I propose we remove the top-level models folder and copy all the jupyter notebooks into

snewpy/doc/nb
JostMigenda commented 3 months ago

[Using this issue to follow-up on this comment in #294]

Right now most Jupyter notebooks are only in the snewpy-models-ccsn repo. (The exception being notebooks for the recently added Fornax_2022 and Mori_2023 models, which are both in doc/nb/ and in the models repo.)

I don’t have particularly strong feelings on which repo they should go in, but a slight preference for the snewpy repo here: Based on experience, changes to SNEWPY occasionally require changes to the sample notebooks, while changes to input files almost never do. Thus, it’s more convenient to keep notebooks here and update them in the same PR, if necessary.

Just one note: I’d prefer something like doc/nb/ccsn/ (or doc/nb/presn/, as appropriate); otherwise, the handful of not model-specific demo notebooks get buried under dozens of model notebooks.

Sheshuk commented 3 months ago

I agree - the notebooks make more sense inside SNEWPY, otherwise it's quickly getting out of sync with the main repository.

For example right now the preSN notebooks are in sync with the HEAD version of snewpy/main, but the user who tries to run it with latest tag v1.4.1 will be confused