addisonhowe / phys2ddm Goto Github PK

I think we should add a license to all tutorials in the repo. Here's an example of what I added in mine:

code

(c) 2024 Manuel Razo. This work is licensed under a [Creative Commons Attribution License CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/). All code contained herein is licensed under an [MIT license](https://opensource.org/licenses/MIT).

rendering

(c) 2024 Manuel Razo. This work is licensed under a Creative Commons Attribution License CC-BY 4.0. All code contained herein is licensed under an MIT license.

For my tutorial, I also used seaborn to improve my plots and watermark to generate at the end of the notebook a watermark on the version of the software used. It looks something like this:

%load_ext watermark
%watermark -v -p numpy,scipy,pandas,matplotlib,seaborn

which prints the following:

Python implementation: CPython
Python version       : 3.10.14
IPython version      : 8.22.2

numpy     : 1.26.4
scipy     : 1.12.0
pandas    : 2.2.1
matplotlib: 3.8.3
seaborn   : 0.13.2

I think that every tutorial should include this for reproducibility.

Can these two dependencies be added to the README.md file?