spinal-cord-7t / coil-qc-code

7T Spinal Cord Coil QC Analysis Code
0 stars 0 forks source link

Do not upload generated images alongside the notebook #5

Closed jcohenadad closed 1 month ago

jcohenadad commented 7 months ago

The notebook is saved with the outputs, which adds binary data on GH: image

It is generally recommended to not save the outputs, for more efficient version control (and not add unnecessary binaries to the git history)

More details at: https://discourse.jupyter.org/t/how-to-version-jupyter-notebooks-in-git-without-output/10748

jcohenadad commented 7 months ago

In fact, editing the code on GitHub doesn't even work: image

Making it extremely difficult to comment, add suggestions, etc.

I suggest to remove that file, and upload another one without the outputs. I also suggest changing the name for something more generic (ie without Kyota's name) and without space for UNIX compatibility, eg: THS_CoilQA_code.ipynb

Kyota-exe commented 7 months ago

5a9b793 solves this.

I haven’t found any way to upload the notebook without outputs without first clearing all the outputs from Google Colab first, which makes it slightly inconvenient, because it means you have to rerun the notebook for the outputs after pushing to GitHub, which usually takes a while. I don’t think there’s a way around this though.

jcohenadad commented 7 months ago

Fixed by https://github.com/spinal-cord-7t/coil-qc-code/commit/5a9b7939122e2ebdb6911e7e7badd165b94bdfc6

jcohenadad commented 4 months ago

Reopening this issue because binaries and notebook outputs were again pushed to the main branch in https://github.com/spinal-cord-7t/coil-qc-code/pull/11

Kyota-exe commented 1 month ago

Closing as this was resolved for #11 by @evaalonsoortiz.