search

litmining / labelbuddy-annotations

Annotations of academic papers. The papers were likely gathered using pubget, and the annotations made with labelbuddy
https://litmining.github.io/labelbuddy-annotations/
MIT License
12 stars 17 forks source link

create some jupyter books and display them in a sphynx gallery on github pages #5

Closed koudyk closed 1 year ago

koudyk commented 1 year ago

pages to include

jeromedockes commented 1 year ago

the gh pages is now online https://neurodatascience.github.io/labelbuddy-annotations/

we can start adding content, eg adding the number of participants notebook to the jupyter-book (in py or md format, translation is easy to do with jupytext). we will also want to add a few instructions for people wanting to add content

koudyk commented 1 year ago

Looks awesome, thanks! Should we include the notebook I created to display the number of participants?

jeromedockes commented 1 year ago

Should we include the notebook I created to display the number of participants?

That would be great, thanks! The first step would be to convert to either .py or .md format because these formats work better with git.

pip install jupytext jupytext plot_n_participants.ipynb --to py

this will create a .py file with some light markup (eg to indicate cell boundaries) that makes it render nicely in the jupyter book.

once this is done we can work together on removing the dependency on the participants_demographics package and including this page in the book; but I didn't want to do the conversion myself because it creates a completely new file and would have made the fact you are the author of the original file a bit hard to see in the git history.

koudyk commented 1 year ago

Okay, I added the file. At first, I had forgotten to first pull your re-organization changes before creating the .py file. After I pulled, it disappeared for some reason (maybe because it was moved). So I converted it again. Now it's in the analysis folder. Is that a good place for it?

jeromedockes commented 1 year ago

Okay, I added the file. At first, I had forgotten to first pull your re-organization changes before creating the .py file. After I pulled, it disappeared for some reason (maybe because it was moved). So I converted it again. Now it's in the analysis folder. Is that a good place for it?

As we want it to become a page of the jupyter "book" we will need to put it in analysis/book. but maybe we should put everything directly in analysis/ and have one less level in the directory tree