Skip to content

Commit 8d0c8f7

Browse files
committed
add documentation for binder to readme and examples docs
1 parent b8912ee commit 8d0c8f7

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ PROCESS was originally a Fortran code, but is now a pure-Python command line pro
1717
## Getting Started
1818
Please see the [installation guide](https://ukaea.github.io/PROCESS/installation/introduction/) and the [usage guide](https://ukaea.github.io/PROCESS/usage/running-process/). Once installed, take a look at the [examples page](https://ukaea.github.io/PROCESS/usage/examples/) for examples of how PROCESS can be run, and its results visualised.
1919

20+
If you wish to run the examples before installing, you can click on the `binder` badge at the top of the README, or
21+
can click [here](https://mybinder.org/v2/gh/ukaea/PROCESS/HEAD). Once loaded, you can double click the `examples` tab down the
22+
left hand side and select an example to run using jupyter. There is also a terminal option in Binder which would allow you to run
23+
PROCESS from your browser.
24+
2025
## Documentation
2126
To read about how the code works and the modules in it see the [documentation](https://ukaea.github.io/PROCESS/).
2227

documentation/usage/examples.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ python -m notebook
3535

3636
A web browser will open and the notebook can be run from there. If you're using WSL, you'll have to `ctrl + click` the link.
3737

38+
### Notebooks via Binder
39+
Another way of running the PROCESS example notebooks is to use Binder. This uses a JupyterHub server to host the contents of
40+
PROCESS, allowing the examples to be run via a web browser and without installation on your computer. You can click
41+
[here](https://mybinder.org/v2/gh/ukaea/PROCESS/HEAD) to try this out.
42+
The Binder may take some time to load, but once loaded you will see options down the left hand side - double click on `examples` and then `examples.ipynb`, then you can run this notebook in your web browser.
3843

3944
## Maintaining notebooks
4045

0 commit comments

Comments
 (0)