Add deprecation notice on all old Jupyter notebooks and scripts #63

songtech-0912 commented 2026年06月22日 03:50:48 +02:00

We have a lot of our simulations code in Jupyter notebooks and scripts, but many of these are redundant or no longer updated - something that isn't easy to tell by inspection for those who are not actively working on simulations. Since our membership isn't fixed, it is essential that we put deprecation notices on these notebooks/scripts that the notebooks/scripts represent past work that is possibly no longer up-to-date.

We have a lot of our simulations code in Jupyter notebooks and scripts, but many of these are redundant or no longer updated - something that isn't easy to tell by inspection for those who are not actively working on simulations. Since our membership isn't fixed, it is essential that we put deprecation notices on these notebooks/scripts that the notebooks/scripts represent past work that is possibly no longer up-to-date.

songtech-0912 commented 2026年06月23日 06:57:50 +02:00

For deprecation notices, I think something like this (placed in a markdown block) should work work, in cases where we have a notebook that has been replaced by a more powerful script/library:

**IMPORTANT: This notebook is no longer updated. Please see `SomeUpdatedSimulation.py` for more up-to-date versions of the simulations in this notebook.**

Or if a simulation is completely archived and no longer relevant:

**IMPORTANT: This notebook is no longer updated and is kept for archival purposes only.**

For deprecation notices, I think something like this (placed in a markdown block) should work work, in cases where we have a notebook that has been replaced by a more powerful script/library: ```markdown **IMPORTANT: This notebook is no longer updated. Please see `SomeUpdatedSimulation.py` for more up-to-date versions of the simulations in this notebook.** ``` Or if a simulation is completely archived and no longer relevant: ```markdown **IMPORTANT: This notebook is no longer updated and is kept for archival purposes only.** ```