https://github.com/brian-team/brian2-doc-resources
Images (and Jupyter Notebooks with images embedded) for the Brian2 documentation
https://github.com/brian-team/brian2-doc-resources
Last synced: about 1 month ago
JSON representation
Images (and Jupyter Notebooks with images embedded) for the Brian2 documentation
- Host: GitHub
- URL: https://github.com/brian-team/brian2-doc-resources
- Owner: brian-team
- Created: 2015-03-06T17:16:46.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T12:16:10.000Z (9 months ago)
- Last Synced: 2024-09-12T23:34:18.222Z (9 months ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 37.2 MB
- Stars: 1
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This repository contains automatically generated files for the Brian 2
documentation.
**Please do not change files in this repository directly, and do not
open pull requests against this repository.**
This repository is used as a submodule in the main Brian 2 repository so
that its documentation can be displayed on http://brian2.readthedocs.org,
without storing big image files directly in the main repository.
The files stored in this repository are:
* Figures generated by examples (folder `example_images`). To make
changes, change the respective example script directly in the
`examples` folder of the brian-team/brian2 repository. To update the
images in this repository, run the `dev/tools/run_examples.py` script
(in the brian-team/brian2 repository).
* Jupyter notebooks for the tutorials that have been executed, i.e.
with images stored as part of the notebook, as well as restructured
text versions of these notebooks with the images stored as separate
files (all in the `tutorials` folder). To make changes to these
tutorials, edit the `.ipynb` files in the `tutorials` folder of the
brian-team/brian2 repository. Note that the files commited there
should be cleared of all output before commiting them. Then run the
`dev/tools/docs/build_tutorials.py` script to generate the files for
this repository.