The Jupyter / iPython training notebooks are the source materials for the GridAPPS-D ReadTheDocs website.
The notebooks include all the code examples and sample app materials in a format that can connect to a local GridAPPS-D platform session and interact in real-time with simulations in real-time.
In the terminal window (use Miniconda terminal in Windows 10), clone the python notebooks by running git clone https://github.com/GRIDAPPSD/gridappsd-training
to download the python training notebooks.
Start the Jupyter notebooks running on port 8890 (to avoid port sharing conflict with the GridAPPS-D Blazegraph database container):
jupyter notebook --port 8890
If running on a remote server (e.g. AWS cloud or university / laboratory server farm), start the notebooks by running
jupyter notebook --port 8890 --no-browser --ip='0.0.0.0'
Images embedded in the python notebooks must be formatted correctly to be converted by readthedocs:
![Example-image](../images/new_image.png)
module-content
directoryremove_cell
tag to flag any sections in python notebooks that should not be exported to readthedocs~/images/section_number
folder./convert_notebooks.sh
script to generate readthedocs files. These are saved in the module-content/docs/source
directory