Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
Also, minor changes to import functions
  • Loading branch information
JamesPHoughton committed Jun 26, 2015
1 parent 2b9ab2d commit 7728a78
Show file tree
Hide file tree
Showing 86 changed files with 3,376 additions and 13,842 deletions.
Binary file modified docs/_build/doctrees/advanced_usage.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/basic_usage.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/development/developer.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/development/internal_functions.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/functions.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/installation.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/translation.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 3a45937101c96d0b3805a4f4f8af582d
config: ef37516a216d74ddd282403badf32d0c
tags: 645f666f9bcd5a90fca523b33c5a78b7
40 changes: 22 additions & 18 deletions docs/_build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,25 +94,29 @@
</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="../development/developer.html">Developer Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/developer.html#motivation-the-coming-of-age-of-big-data">Motivation: The (coming of) age of Big Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/developer.html#general-approaches-for-integrating-system-dynamic-models-and-data-analytics">General approaches for integrating system dynamic models and data analytics</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/developer.html#structure-of-the-pysd-module">Structure of the PySD module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../development/developer.html#builder">Builder</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/developer.html#translation">Translation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/developer.html#the-model-class">The model class</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/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>
<li class="toctree-l3"><a class="reference internal" href="../development/structure.html#the-model-class">The model class</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../development/internal_functions.html">Internal Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/internal_functions.html#special-functions-needed-for-model-execution">Special functions needed for model execution</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/internal_functions.html#building-the-python-model-file">Building the python model file</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/internal_functions.html">Internal Functions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../development/internal_functions.html#special-functions-needed-for-model-execution">Special functions needed for model execution</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/internal_functions.html#building-the-python-model-file">Building the python model file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../development/translation.html">Translation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/translation.html#types">Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/translation.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/vensim_translation.html">Vensim Translation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../development/vensim_translation.html#types">Types</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/vensim_translation.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../development/xmile_translation.html">XMILE Translation</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -151,10 +155,10 @@
<div role="main" class="document">

<h1>All modules for which code is available</h1>
<ul><li><a href="pysd/builder/builder.html">pysd.builder.builder</a></li>
<li><a href="pysd/functions/functions.html">pysd.functions.functions</a></li>
<li><a href="pysd/pysd.html">pysd.pysd</a></li>
</ul>
<ul><li><a href="pysd.html">pysd</a></li>
<ul><li><a href="pysd/builder.html">pysd.builder</a></li>
<li><a href="pysd/functions.html">pysd.functions</a></li>
</ul></ul>

</div>
<footer>
Expand Down Expand Up @@ -194,7 +198,7 @@ <h1>All modules for which code is available</h1>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>



Expand Down
223 changes: 223 additions & 0 deletions docs/_build/html/_modules/pysd.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>pysd &mdash; PySD 0.3.0 documentation</title>















<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />





<link rel="top" title="PySD 0.3.0 documentation" href="../index.html"/>
<link rel="up" title="Module code" href="index.html"/>


<script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">


<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">



<a href="../index.html" class="icon icon-home"> PySD



</a>


<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">



<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#installing-via-pip">Installing via pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#installing-from-source">Installing from source</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#required-dependencies">Required Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#optional-dependencies">Optional Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../installation.html#additional-resources">Additional Resources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../basic_usage.html">Basic Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../basic_usage.html#importing-a-model-and-getting-started">Importing a model and getting started</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basic_usage.html#running-the-model">Running the Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basic_usage.html#outputting-various-run-information">Outputting various run information</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basic_usage.html#setting-parameter-values">Setting parameter values</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basic_usage.html#setting-simulation-initial-conditions">Setting simulation initial conditions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basic_usage.html#querying-current-values">Querying current values</a></li>
<li class="toctree-l2"><a class="reference internal" href="../basic_usage.html#collecting-a-history-of-returned-values">Collecting a history of returned values</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../advanced_usage.html">Advanced Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../advanced_usage.html#replacing-model-components-with-more-complex-objects">Replacing model components with more complex objects</a></li>
<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="../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/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>
<li class="toctree-l3"><a class="reference internal" href="../development/structure.html#the-model-class">The model class</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../development/internal_functions.html">Internal Functions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../development/internal_functions.html#special-functions-needed-for-model-execution">Special functions needed for model execution</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/internal_functions.html#building-the-python-model-file">Building the python model file</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../development/vensim_translation.html">Vensim Translation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../development/vensim_translation.html#types">Types</a></li>
<li class="toctree-l3"><a class="reference internal" href="../development/vensim_translation.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../development/xmile_translation.html">XMILE Translation</a></li>
</ul>
</li>
</ul>



</div>
&nbsp;
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">PySD</a>
</nav>



<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs</a> &raquo;</li>

<li><a href="index.html">Module code</a> &raquo;</li>

<li>pysd</li>
<li class="wy-breadcrumbs-aside">



</li>
</ul>
<hr/>
</div>
<div role="main" class="document">

<h1>Source code for pysd</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">.pysd</span> <span class="kn">import</span> <span class="n">read_xmile</span><span class="p">,</span> <span class="n">read_vensim</span><span class="p">,</span> <span class="n">load</span>
<span class="kn">from</span> <span class="nn">.pysd</span> <span class="kn">import</span> <span class="n">PySD</span>
<span class="kn">from</span> <span class="nn">._version</span> <span class="kn">import</span> <span class="n">__version__</span>
</pre></div>

</div>
<footer>


<hr/>

<div role="contentinfo">
<p>
&copy; Copyright 2015, James Houghton.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

</section>

</div>





<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'0.3.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>





<script type="text/javascript" src="../_static/js/theme.js"></script>




<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>


</body>
</html>

0 comments on commit 7728a78

Please sign in to comment.