Organize ioSPI's notebooks

[ninamiolane]

What?

• Create a tutorial called particle_metadata.ipynb that explains the use of the ioSPI/particle_metadata module
• Create a tutorial called download_and_upload_from_osf.ipynb that explains the use of ioSPI/datasets module.
• Add corresponding unit-tests.
• Use pre-commit (see README) to make sure that your code follows style guidelines.

Both of these tutorials should be created by reorganizing elements in existing noteboooks (see "How" section below).

Why?

Current tutorials on these two modules are hard to understand and use for newcomers, because as of now:

• there is a single tutorial (called tutorial.ipynb) that mixes both modules without explaining the link between the two,
• there is a half-working draft tutorial (called download_and_upload_from_osf.ipynb) hidden in PR#70 that users will not find,
• the text in these tutorials can be hard to understand for newcomers.

The library ioSPI can only be useful if users can understand it quickly. This task is urgent and very much needed.

Where?

The 2 new tutorials created by this task should go in the ioSPI/notebooks/ folder and be named:

• particle_metadata.ipynb
• download_and_upload_from_osf.ipynb

The 2 new tutorials are created from existing tutorials that can be found at:

• ioSPI/notebooks/tutorial.ipynb
• an on-going pull request PR#70

The main modules that the 2 new tutorials should explain are:

• ioSPI/particle_metadata.py
• ioSPI/datasets.py

How?

The new tutorial particle_metadata.ipynb should be created by:

• extracting the first part of ioSPI/notebooks/tutorial.ipynb
• reformulating the text to make it more interesting and more readable for a newcomer

The new tutorial download_and_upload_from_osf.ipynb should be created by:

• getting the notebook download_and_upload_from_osf.ipynb from the on-going PR#70.
• extracting the second part of ioSPI/notebooks/tutorial.ipynb and copy-pasting it at the end of download_and_upload_from_osf.ipynb
• getting the modifications of the datasets.py module from the on-going PR#70.
• reformulating the text to make it into a consistent notebook.

[ninamiolane]

@bongjinkoo : as mentioned by @geoffwoollard , unit-tests should be added.

[bongjinkoo]

@ninamiolane Can we close this?

[ninamiolane]

@bongjinkoo we can, as soon as the PR with the file test_notebooks.py can be merged! I.e. we want the notebooks to be tested.