Open ninamiolane opened 2 years ago
@bongjinkoo : as mentioned by @geoffwoollard , unit-tests should be added.
@ninamiolane Can we close this?
@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.
What?
particle_metadata.ipynb
that explains the use of the ioSPI/particle_metadata moduledownload_and_upload_from_osf.ipynb
that explains the use of ioSPI/datasets module.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:
tutorial.ipynb
) that mixes both modules without explaining the link between the two,download_and_upload_from_osf.ipynb
) hidden in PR#70 that users will not find,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:
The main modules that the 2 new tutorials should explain are:
How?
The new tutorial
particle_metadata.ipynb
should be created by:The new tutorial
download_and_upload_from_osf.ipynb
should be created by:download_and_upload_from_osf.ipynb
from the on-going PR#70.download_and_upload_from_osf.ipynb
datasets.py
module from the on-going PR#70.