search

neurolibre / docs.neurolibre.org

Repository containing all the documentation related to neurolibre.
https://docs.neurolibre.com
Other
2 stars 5 forks source link

document jb debugging #27

Closed ltetrel closed 2 years ago

ltetrel commented 2 years ago

debugging is a long process that should be done directly on our system, and not on user system, This helps alleviate build/execution errors (environment, and hardware).

ltetrel commented 2 years ago

Binder session is always spawned after the jupyter-book build, including running notebooks. If a user has long-running notebooks such as nimare submission, the spawning will take too long because it will wait for jupyter-book build to finish (succeed or fail). One way for user to quickly debug their notebook inside binder is to use the flag neurolibre-debug in their latest commit message, this will bypass jupyter-book build step when asking a binder instance. This is obviously just for debugging purpose, final submission should build jb. This is also an issue just on the test environment, on the production no jb build is performed. https://github.com/neurolibre/terraform-binderhub/commit/d6794196585d7becf2bef719c8e4ae7c2a8728e9#diff-f57f86ab8bc7ba0d92e1feafb335d098cd2aadc775cfefbdb8624b2c6c70a39e

ltetrel commented 2 years ago

jb build can be done inside a terminal session (on binder). https://github.com/neurolibre/neurolibre-reviews/issues/7#issuecomment-1040817373

ltetrel commented 2 years ago

https://github.com/neurolibre/docs.neurolibre.org/commit/65bfb4b081d8689782f9345e2c2adb8c2c80ad23