Skip to content

Commit 2ee1ce8

Browse files
Add note about PySD version
1 parent 6d7f036 commit 2ee1ce8

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,7 @@ If you want to implement a recipe, you can then make a copy of the notebook you
2828

2929
To download the cookbook in its entirity, use [this link](https://github.com/SDXorg/PySD-Cookbook/archive/master.zip) or select one of the options in the righthand panel of the github window.
3030

31+
At least PySD 3.0.0 is needed to run these notebooks. However, we recommend using the latest available PySD version ([check also for its requirements](https://pysd.readthedocs.io/en/master/installation.html)).
32+
3133
### Structure of this repository
3234
As several recipes may use the same models or the same data, I've separated the recipes into a directory called [Analyses](https://github.com/SDXorg/PySD-Cookbook/tree/master/source/analyses) where individual recipes are grouped by category. The [Data](https://github.com/SDXorg/PySD-Cookbook/tree/master/source/data) directory contains all of the data used in the analyses, and in most cases notebooks describing the data, where it came from, and how it is formatted. The [Models](https://github.com/SDXorg/PySD-Cookbook/tree/master/source/models) directory includes the various model files that are used throughout the analyses.

docs/index.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,12 @@ Simple recipes for powerful analysis of system dynamics models
99

1010
Quickstart
1111
----------
12-
1. Download and install `Anaconda Python 3.7+ <https://www.continuum.io/downloads>`_
13-
2. Install PySD with pip using the command :code:`pip install pysd` at your command prompt
14-
3. `Download this cookbook <https://github.com/SDXorg/PySD-Cookbook/archive/master.zip>`_
12+
1. `Install PySD <https://pysd.readthedocs.io/en/master/installation.html>`_ (we recommend using the latest available PySD version) and needed `requirements for the notebooks <https://github.com/SDXorg/PySD-Cookbook/blob/master/requirements.txt>`_
13+
2. `Download this cookbook <https://github.com/SDXorg/PySD-Cookbook/archive/master.zip>`_
1514
and unzip it to a working directory
16-
4. Navigate your command prompt to the working directory just created
17-
5. Launch ipython notebook with the command :code:`ipython notebook` at your command prompt
18-
6. In the ipython browser, open :code:`source\analyses\getting_started\Hello_World_Teacup.ipynb`
15+
3. Navigate your command prompt to the working directory just created
16+
4. Launch ipython notebook with the command :code:`ipython notebook` at your command prompt
17+
5. In the ipython browser, open :code:`source\analyses\getting_started\Hello_World_Teacup.ipynb`
1918

2019

2120
How to use this cookbook

0 commit comments

Comments
 (0)