Update docs

SDXorg · Jun 26, 2015 · 8fbd549 · 8fbd549
1 parent 1198e8b
commit 8fbd549
Show file tree

Hide file tree

Showing 41 changed files with 1,057 additions and 38 deletions.
diff --git a/docs/_build/doctrees/advanced_usage.doctree b/docs/_build/doctrees/advanced_usage.doctree
diff --git a/docs/_build/doctrees/development/complement.doctree b/docs/_build/doctrees/development/complement.doctree
diff --git a/docs/_build/doctrees/development/development_index.doctree b/docs/_build/doctrees/development/development_index.doctree
diff --git a/docs/_build/doctrees/development/pathway.doctree b/docs/_build/doctrees/development/pathway.doctree
diff --git a/docs/_build/doctrees/development/philosophy.doctree b/docs/_build/doctrees/development/philosophy.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/functions.doctree b/docs/_build/doctrees/functions.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -93,13 +93,14 @@
 <li class="toctree-l2"><a class="reference internal" href="../advanced_usage.html#supplying-additional-arguments-to-the-integrator">Supplying additional arguments to the integrator</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../functions.html">User Functions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../functions.html">User Functions Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../development/development_index.html">Developer Documentation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../development/motivation.html">Motivation of PySD</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../development/motivation.html#the-coming-of-age-of-big-data">The (coming of) age of Big Data</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../development/motivation.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="../development/philosophy.html">PySD Design Philosophy</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../development/structure.html">Structure of the PySD module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../development/structure.html#builder">Builder</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../development/structure.html#translation">Translation</a></li>
@@ -117,6 +118,12 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../development/xmile_translation.html">XMILE Translation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/pathway.html">PySD Development Pathway</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../development/pathway.html#current-features">Current Features</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../development/pathway.html#possible-future-features">Possible Future features</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../development/complement.html">Complementary Projects</a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/_build/html/_modules/pysd.html b/docs/_build/html/_modules/pysd.html
@@ -94,13 +94,14 @@
 <li class="toctree-l2"><a class="reference internal" href="../advanced_usage.html#supplying-additional-arguments-to-the-integrator">Supplying additional arguments to the integrator</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../functions.html">User Functions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../functions.html">User Functions Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../development/development_index.html">Developer Documentation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../development/motivation.html">Motivation of PySD</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../development/motivation.html#the-coming-of-age-of-big-data">The (coming of) age of Big Data</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../development/motivation.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="../development/philosophy.html">PySD Design Philosophy</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../development/structure.html">Structure of the PySD module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../development/structure.html#builder">Builder</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../development/structure.html#translation">Translation</a></li>
@@ -118,6 +119,12 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../development/xmile_translation.html">XMILE Translation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../development/pathway.html">PySD Development Pathway</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../development/pathway.html#current-features">Current Features</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../development/pathway.html#possible-future-features">Possible Future features</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../development/complement.html">Complementary Projects</a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/_build/html/_modules/pysd/builder.html b/docs/_build/html/_modules/pysd/builder.html
@@ -94,13 +94,14 @@
 <li class="toctree-l2"><a class="reference internal" href="../../advanced_usage.html#supplying-additional-arguments-to-the-integrator">Supplying additional arguments to the integrator</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">User Functions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions.html">User Functions Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../development/development_index.html">Developer Documentation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../development/motivation.html">Motivation of PySD</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../development/motivation.html#the-coming-of-age-of-big-data">The (coming of) age of Big Data</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../development/motivation.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/philosophy.html">PySD Design Philosophy</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../development/structure.html">Structure of the PySD module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../development/structure.html#builder">Builder</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../development/structure.html#translation">Translation</a></li>
@@ -118,6 +119,12 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../../development/xmile_translation.html">XMILE Translation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/pathway.html">PySD Development Pathway</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../development/pathway.html#current-features">Current Features</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../development/pathway.html#possible-future-features">Possible Future features</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/complement.html">Complementary Projects</a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/_build/html/_modules/pysd/functions.html b/docs/_build/html/_modules/pysd/functions.html
@@ -94,13 +94,14 @@
 <li class="toctree-l2"><a class="reference internal" href="../../advanced_usage.html#supplying-additional-arguments-to-the-integrator">Supplying additional arguments to the integrator</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">User Functions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions.html">User Functions Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../development/development_index.html">Developer Documentation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../development/motivation.html">Motivation of PySD</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../development/motivation.html#the-coming-of-age-of-big-data">The (coming of) age of Big Data</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../development/motivation.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/philosophy.html">PySD Design Philosophy</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../../development/structure.html">Structure of the PySD module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="../../development/structure.html#builder">Builder</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../../development/structure.html#translation">Translation</a></li>
@@ -118,6 +119,12 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="../../development/xmile_translation.html">XMILE Translation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/pathway.html">PySD Development Pathway</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../development/pathway.html#current-features">Current Features</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../development/pathway.html#possible-future-features">Possible Future features</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../../development/complement.html">Complementary Projects</a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/_build/html/_sources/development/complement.txt b/docs/_build/html/_sources/development/complement.txt
@@ -0,0 +1,10 @@
+Complementary Projects
+======================
+
+The most valuable component for better integrating models with *basically anything else* is a standard language for communicating the structure of those models. That language is `XMILE <http://www.iseesystems.com/community/support/XMILE.aspx>`_. The draft specifications for this have been finalized and the standard should be approved in the next few months.
+
+A python library for analyzing system dynamics models called the `Exploratory Modeling and Analysis (EMA) Workbench <http://simulation.tbm.tudelft.nl/ema-workbench/contents.html>`_ is being developed by `Erik Pruyt <http://www.tbm.tudelft.nl/en/about-faculty/departments/multi-actor-systems/policy-analysis/people/erik-pruyt/>`_ and `Jan Kwakkel <https://github.com/quaquel>`_ at TU Delft. This package implements a variety of analysis methods that are unique to dynamic models, and could work very tightly with PySD.
+
+An excellent javascript library called `sd.js <https://github.com/bpowers/sd.js/tree/master>`_ created by Bobby Powers at `SDlabs <http://sdlabs.io/>`_ exists as a standalone SD engine, and provides a beautiful front end. This front end could be rendered as an iPython widget to facilitate display of SD models.
+
+The `Behavior Analysis and Testing Software(BATS) <http://www.ie.boun.edu.tr/labs/sesdyn/projects/bats/index.html>`_ delveloped by `Gönenç Yücel <http://www.ie.boun.edu.tr/people/pages/yucel.html>`_ includes a really neat method for categorizing behavior modes and exploring parameter space to determine the boundaries between them.
diff --git a/docs/_build/html/_sources/development/development_index.txt b/docs/_build/html/_sources/development/development_index.txt
@@ -6,7 +6,10 @@ Developer Documentation
    :maxdepth: 2
 
    motivation
+   philosophy
    structure
    internal_functions
    vensim_translation
-   xmile_translation
+   xmile_translation
+   pathway
+   complement
diff --git a/docs/_build/html/_sources/development/pathway.txt b/docs/_build/html/_sources/development/pathway.txt
@@ -0,0 +1,33 @@
+PySD Development Pathway
+========================
+
+The basic use case of PySD is for a user to import a fully developed SD model (created in Vensim, or Stella/iThink, etc.) into python; and then use third party tools to perform statistical analysis and inference, and to interface with external data.
+
+Current Features
+----------------
+
+* Basic XMILE and Vensim parser,
+* Established library structure and data formats
+* Simulation using existing python integration tools
+* Basic demonstrations of integration with python Data Science functionality
+* Run-at-a-time parameter modification
+* Step-at-a-time parameter modification / time-variant exogenous inputs
+* Extended backends for storing parameters and output values
+* Demonstration of integration with Machine Learning/Monte Carlo/Statistical Methods
+* Python methods for programmatically manipulating SD model structure
+* Turn off and on 'traces' or records of the values of variables
+
+Possible Future features
+------------------------
+
+* Complete parsers (including subscripting, etc)
+* Embed SD.js front end in iPython widget
+* XMILE display component parser
+* Customizations of external Data Science tools for dynamic systems
+* Incorporation of analysis tools specific to dynamic systems
+* Additional SD tools: checks for model units, value limits, etc.
+* Python methods for saving XMILE models
+* Hover over stock/flow elements to get things like units, descriptions, values, etc.
+* Output DataFrame including tags for units
+
+
diff --git a/docs/_build/html/_sources/development/philosophy.txt b/docs/_build/html/_sources/development/philosophy.txt
@@ -0,0 +1,11 @@
+PySD Design Philosophy
+======================
+
+* Do as little as possible.
+ * Anything that is not endemic to System Dynamics (such as plotting, integration, fitting, etc) should either be implemented using external tools, or omitted.
+ * Stick to SD. Let other disciplines (ABM, Discrete Event Simulation, etc) create their own tools.
+ * Use external model creation tools
+* Use the language of system dynamics.
+* Be simple to use. Let SD practitioners who haven't used python before understand the basics.
+* Take advantage of general python constructions and best practices.
+* Be simple to maintain.
diff --git a/docs/_build/html/_sources/functions.txt b/docs/_build/html/_sources/functions.txt
@@ -1,5 +1,5 @@
-User Functions
-==============
+User Functions Reference
+========================
 
 These are the primary functions that control model import and execution.
 

diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt
@@ -26,7 +26,7 @@ A collection of simple recipes for advanced data analytics using PySD is availab
 The cookbook includes models, sample data, and code in the form of ipython notebooks that demonstrate a variety of data integration and analysis tasks, including:
 
 * `Getting started with PySD and the Python data analytics stack <http://nbviewer.ipython.org/github/JamesPHoughton/PySD-Cookbook/blob/master/1_2_Installation_and_Setup.ipynb>`_
-* `Basic PySD usage' <'http://nbviewer.ipython.org/github/JamesPHoughton/PySD-Cookbook/blob/master/1_3_Hello_World_Teacup.ipynb>`_
+* `Basic PySD usage <'http://nbviewer.ipython.org/github/JamesPHoughton/PySD-Cookbook/blob/master/1_3_Hello_World_Teacup.ipynb>`_
 * `Optimizing models with run-at-a-time data fitting <http://nbviewer.ipython.org/github/JamesPHoughton/PySD-Cookbook/blob/master/2_1_Fitting_with_Optimization.ipynb>`_
 * `Optimizing models with step-at-a-time data fitting <http://nbviewer.ipython.org/github/JamesPHoughton/PySD-Cookbook/blob/master/2_2_Step_at_a_time_optimization.ipynb>`_
 * `Fitting and exploring models across geographic scales <http://nbviewer.ipython.org/github/JamesPHoughton/PySD-Cookbook/blob/master/Exploring%20models%20across%20geographic%20scales.ipynb>`_

diff --git a/docs/_build/html/advanced_usage.html b/docs/_build/html/advanced_usage.html
@@ -31,7 +31,7 @@
 
 
     <link rel="top" title="PySD 0.3.0 documentation" href="index.html"/>
-        <link rel="next" title="User Functions" href="functions.html"/>
+        <link rel="next" title="User Functions Reference" href="functions.html"/>
         <link rel="prev" title="Basic Usage" href="basic_usage.html"/> 
 
 
@@ -95,13 +95,14 @@
 <li class="toctree-l2"><a class="reference internal" href="#supplying-additional-arguments-to-the-integrator">Supplying additional arguments to the integrator</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="functions.html">User Functions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="functions.html">User Functions Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="development/development_index.html">Developer Documentation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="development/motivation.html">Motivation of PySD</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="development/motivation.html#the-coming-of-age-of-big-data">The (coming of) age of Big Data</a></li>
 <li class="toctree-l3"><a class="reference internal" href="development/motivation.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="development/philosophy.html">PySD Design Philosophy</a></li>
 <li class="toctree-l2"><a class="reference internal" href="development/structure.html">Structure of the PySD module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="development/structure.html#builder">Builder</a></li>
 <li class="toctree-l3"><a class="reference internal" href="development/structure.html#translation">Translation</a></li>
@@ -119,6 +120,12 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="development/xmile_translation.html">XMILE Translation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="development/pathway.html">PySD Development Pathway</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="development/pathway.html#current-features">Current Features</a></li>
+<li class="toctree-l3"><a class="reference internal" href="development/pathway.html#possible-future-features">Possible Future features</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="development/complement.html">Complementary Projects</a></li>
 </ul>
 </li>
 </ul>
@@ -207,7 +214,7 @@ <h2>Supplying additional arguments to the integrator<a class="headerlink" href="
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="functions.html" class="btn btn-neutral float-right" title="User Functions" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="functions.html" class="btn btn-neutral float-right" title="User Functions Reference" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="basic_usage.html" class="btn btn-neutral" title="Basic Usage" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>