add docs html

Author: ThibHlln

docs/.buildinfo

@@ -0,0 +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: 4956aeab6309c507fe434630bfafbc9b
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_images/smart-model-structure.svg

@@ -0,0 +1,7 @@
+:root {
+--tabs-color-label-active: hsla(231, 99%, 66%, 1);
+--tabs-color-label-inactive: rgba(178, 206, 245, 0.62);
+--tabs-color-overline: rgb(207, 236, 238);
+--tabs-color-underline: rgb(207, 236, 238);
+--tabs-size-label: 1rem;
+}

docs/_panels_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css

@@ -0,0 +1,4 @@
+Change Log
+==========
+
+.. include:: ../../changelog.rst

docs/_panels_static/panels-variables.06eb56fa6e07937060861dad626602ad.css

@@ -0,0 +1,33 @@
+.. currentmodule:: smartpy
+.. default-role:: obj
+
+Citation
+========
+
+Software
+--------
+
+If you are using `smartpy`, please consider citing the software as follows
+(click on the link to get the DOI of a specific version and year):
+
+.. pull-quote::
+
+   Hallouin, T., Mockler, E., Bruen, M. (XXXX).
+   SMARTpy: An implementation if the rainfall-runoff model in Python (Version X.X.X).
+   *Zenodo*.
+   `<https://doi.org/10.5281/zenodo.2564041>`_
+
+
+Model
+-----
+
+If you are using `smartpy`, please consider citing the original model
+description article:
+
+.. pull-quote::
+
+   Mockler, E., O’Loughlin, F., and Bruen, M. (2016).
+   Understanding hydrological flow paths in conceptual catchment models
+   using uncertainty and sensitivity analysis.
+   *Computers & Geosciences*, 90, 66–77.
+   `<https://doi.org/10.1016/j.cageo.2015.08.015>`_

docs/_sources/changelog.rst.txt

@@ -0,0 +1,62 @@
+.. currentmodule:: smartpy
+.. default-role:: obj
+
+.. include:: ../../README.rst
+
+Documentation
+-------------
+
+.. panels::
+   :card: + intro-card text-center
+   :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
+
+   Learn how to get `smartpy`.
+
+   +++
+
+   .. link-button:: installation
+      :type: ref
+      :text: Installation
+      :classes: btn-outline-primary btn-block stretched-link
+
+   ---
+
+   Learn how to use `smartpy`.
+
+   +++
+
+   .. link-button:: tutorial
+      :type: ref
+      :text: Tutorial
+      :classes: btn-outline-primary btn-block stretched-link
+
+   ---
+
+   Learn more about SMART.
+
+   +++
+
+   .. link-button:: model_description
+      :type: ref
+      :text: Model Description
+      :classes: btn-outline-primary btn-block stretched-link
+
+
+
+Acknowledgment
+--------------
+
+This model implementation was initially developed with the financial support of
+Ireland's Environmental Protection Agency (Grant Number 2014-W-LS-5).
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   installation
+   tutorial
+   model_description
+   citation
+   support
+   changelog
+   licence

docs/_sources/citation.rst.txt

@@ -0,0 +1,54 @@
+.. currentmodule:: smartpy
+.. default-role:: obj
+
+Installation
+============
+
+If you wish to install the most recent stable version of `smartpy`,
+it is available on the Python Package Index (PyPI), simply run:
+
+.. code-block:: bash
+
+   pip install smartpy
+
+If you need the latest, potentially unstable, features listed in the
+:doc:`change log <changelog>`, please use the *dev* branch on the
+GitHub repository:
+
+.. code-block:: bash
+
+   pip install git+https://github.com/ThibHlln/smartpy.git@dev
+
+
+.. rubric:: Requirements
+
+The following packages are required to use `smartpy`:
+
+.. literalinclude:: ../../requirements.txt
+   :language: none
+
+.. rubric:: Optional dependency for input/output
+
+`smartpy` is designed to read/write CSV (Comma-Separated Values) files
+and NetCDF (Network Common Data Form) input/output files. However, only
+CSV files can natively be read/written in Python.
+
+To read/write NetCDF files, the `netCDF4` python package is required (specific
+pre-requisites prior the installation of `netCDF4` exist and can be found
+at `<http://unidata.github.io/netcdf4-python/>`_).
+
+.. rubric:: Optional dependencies for Monte Carlo experiments
+
+The module `smartpy.montecarlo` requires the `spotpy` Python package
+to perform the sampling required for Monte Carlo experiments
+(`<https://spotpy.readthedocs.io/>`_).
+
+In addition, if this sampling is to be done in parallel, the `mpi4py`
+Python package is also required (`<https://mpi4py.readthedocs.io/>`_)
+
+.. rubric:: Optional dependency for performance improvement
+
+`smartpy` features a separate accelerator extension written in C++,
+`smartcpp` (`<https://github.com/ThibHlln/smartcpp>`_) that will be
+automatically used if it is installed alongside `smartpy`. Using
+`smartcpp` can significantly improve the execution time.

docs/_sources/index.rst.txt

@@ -0,0 +1,4 @@
+Licence
+=======
+
+.. include:: ../../LICENCE.rst