search

Geodels / bioLEC

Landscape Elevational Connectivity package https://biolec.readthedocs.io/
GNU General Public License v3.0
4 stars 3 forks source link

JOSS Review: Notebook file structure confusing #5

Closed kbarnhart closed 5 years ago

kbarnhart commented 5 years ago

Another issue as part of my JOSS Review

I cloned the repo and tried to run the notebooks locally.

After running jupyter notebook from the top level Notebooks directory I opened the 0-StartHere.ipynb notebooks. I then ran into 404 errors with the links to the other notebooks. I assume this is because the are actually located in bioLEC/src/bioLEC/Notebooks

I'd recommend that there is one place for the file structure where the notebooks are located. If for some reason related to Docker that means they need to be in both of these places, perhaps make a note on the ReadTheDocs regarding how to run the notebooks locally).

I poked around in the repo trying to figure out a fix and found the documentation.py file. This may or not matter, but it was not at all clear to me whether the file is vestigial or whether I should have been able to use it to solve my 404 error issues.

tristan-salles commented 5 years ago

I decided to duplicate the notebooks (they are actually really small in size less than 50kb in total) to ensure that the examples were available regardless off the use: local install/kitematic/binder.