Warning
NeuroLibre is at an alpha stage of development, and is not currently open for submissions.
π±οΈ Local testingΒΆ
Assuming that:
- you already installed all the dependencies to develop your notebooks locally
- your preprint repository follows the NeuroLibre π Preprint repository structure.
You can easily test your preprint build locally.
1. Install Jupyter BookΒΆ
pip install jupyter-book
2. Manage your dataΒΆ
Given the following minimalistic repository structure:
.
βββ binder
β βββ requirements.txt
β βββ data_requirement.json
βββ content
β βββ _build
β βββ notebook.ipynb
β βββ _config.ym
β βββ _toc.yml
βββ README.md
Create a directory data
at the root of the repository.
Install Repo2Data and configure the dst
from the requirement file so it points to the data
folder.
pip install repo2data
Run repo2data
inside your notebook and get the path to the data.
# install the data if running locally, or points to cached data if running on neurolibre
data_req_path = os.path.join("..", "binder", "data_requirement.json")
# download data
repo2data = Repo2Data(data_req_path)
data_path = repo2data.install()
See also
Check this example for running repo2data, agnostic to server data path.
3. Book buildΒΆ
- Navigate to the repository location in a terminal
cd /your/repo/directory
- Trigger a jupyter book build
jupyter-book build ./content
See also
Please visit reference documentation on executing and caching your outputs during a book build.