-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7ca1f9c
commit e5e4ba3
Showing
2 changed files
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
User Functions | ||
============== | ||
|
||
.. autofunction:: pysd.read_vensim | ||
|
||
.. autofunction:: pysd.print_supported_vensim_functions | ||
|
||
.. autoclass:: pysd.pysd | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
Installation | ||
============ | ||
|
||
Installing via pip | ||
------------------ | ||
To install the PySD package from the Python package index into an established | ||
Python environment, use the pip command: | ||
|
||
.. code-block:: bash | ||
pip install pysd | ||
Installing from source | ||
---------------------- | ||
To install from the source, clone the project with git: | ||
|
||
.. code-block:: bash | ||
git clone https://github.com/JamesPHoughton/pysd.git | ||
Or download the latest version from the project webpage: https://github.com/JamesPHoughton/pysd | ||
|
||
In the source directory use the command | ||
|
||
.. code-block:: bash | ||
python setup.py install | ||
Required Dependencies | ||
--------------------- | ||
PySD calls on the core Python data analytics stack, and a third party parsing library: | ||
|
||
* Numpy | ||
* Scipy | ||
* Pandas | ||
* Matplotlib | ||
* Parsimonious | ||
|
||
These modules should build automatically if you are installing via `pip`. If you are building from the source code, or if pip fails to load them, they can be loaded with the same `pip` syntax as above. | ||
|
||
Optional Dependencies | ||
--------------------- | ||
These Python libraries bring additional data analytics capabilities to the analysis of SD models: | ||
|
||
* PyMC: a library for performing Markov chain Monte Carlo analysis | ||
* Scikit-learn: a library for performing machine learning in Python | ||
* NetworkX: a library for constructing networks | ||
* GeoPandas: a library for manipulating geographic data | ||
|
||
Additionally, the System Dynamics Translator utility developed by Robert Ward is useful for translating models from other system dynamics formats into the XMILE standard, to be read by PySD. | ||
|
||
These modules can be installed using pip with syntax similar to the above. |