NeuroLibre is at an alpha stage of development, and is not currently open for submissions.
🖱️ Local testing¶
- 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
pip install repo2data
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()
Check this example for running repo2data, agnostic to server data path.