docs: structure and new location

.travis.yml

@@ -34,7 +34,7 @@ cache:
 
 env:
   global:
-  - GH_REF="github.com/schymans/environmental-science-for-sagemath.git"
+  - GH_REF="github.com/environmentalscience/essm.git"
   - secure: KwansI0JAlS1EZe0yPP16mLf16tdy3uT6thiFral7VLA+PsfiEYJbjnkaDBKu/ICB70KK46EA7rJ4bpof0RKDyadTKY1nixDrIVPhFIQaqAuUILmsPmFcS7xzh0DPCz8C1SK01jqJgzutztFCQkQfYjHUL6pHM9x46mImsJLyqmKjT74GGGt29iINkO2jK54WmJWb79G9eWNCGtNCepEXEwQvReD7Bs9oR/ErZULugfZTCsPGMQa40rOt+tW6rYg32hJkGZBU52dUk5VqopLV4eQopkrEvk+5mURewUj+QR59i92jhtHtGqpcl4gGlSRKteII0dNF2KFHLGViOEsSjbKfdcjCnvRawypeEJVvtTizBL2N5zL4Zku56QRZhDSOia/ZyCgXBLQJpxUM/9OxI7c7X87qQGCwvTTg3UqBbYw8NLcuz4UTn0eNXTkguW3w6v9QXpMyiJDIthvSAAuj5JhKKeNrrqCQazSfozjj10YJeZxoMXtm6cjbGhAOJVBBLFEEre33cqv52CrS5aK3Pr5mHIXpNkMVBZpCfzF0e/OHPliSqSsOPeoeKxqLYnJQf/EmGnEPf9LSYSxIxiIdSMrCdlkZf2ysRVSp73BM1w9vOO0vpp2KOQYT58XNc/ex1XE2uh77I48F6SFwYnsTutzyNMKzCqnyTp2STeD/aE=
 
 before_install:

AUTHORS.rst

@@ -0,0 +1,5 @@
+Authors
+=======
+
+- Jiri Kuncar <jiri.kuncar@gmail.com>
+- Stan Schymanski <stan.schymanski@env.ethz.ch>

README.rst

@@ -0,0 +1,28 @@
+==================================
+Environmental Science for SageMath
+==================================
+
+.. image:: https://img.shields.io/travis/environmentalscience/essm.svg
+        :target: https://travis-ci.org/environmentalscience/essm
+
+.. image:: https://img.shields.io/coveralls/environmentalscience/essm.svg
+        :target: https://coveralls.io/r/environmentalscience/essm
+
+.. image:: https://img.shields.io/github/tag/environmentalscience/essm.svg
+        :target: https://github.com/environmentalscience/essm/releases
+
+.. image:: https://img.shields.io/pypi/dm/essm.svg
+        :target: https://pypi.python.org/pypi/essm
+
+.. image:: https://img.shields.io/github/license/environmentalscience/essm.svg
+        :target: https://github.com/environmentalscience/essm/blob/master/LICENSE
+
+This package contains helpers to deal with physical variables and units
+in SageMatch.
+
+The documentation is available on
+https://environmentalscience.github.io/essm/
+
+The quick installation for impatient users can be done by running::
+
+    sage -pip install essm

docs/api.rst

@@ -0,0 +1,87 @@
+========
+API Docs
+========
+
+Variables
+=========
+
+.. automodule:: essm.variables
+
+Chamber
+-------
+
+.. automodule:: essm.variables.chamber
+
+Mass
+~~~~
+
+.. automodule:: essm.variables.chamber.mass
+   :members:
+
+Insulation
+~~~~~~~~~~
+
+.. automodule:: essm.variables.chamber.insulation
+   :members:
+
+Leaf
+----
+
+.. automodule:: essm.variables.leaf
+
+Radiation
+~~~~~~~~~
+
+.. automodule:: essm.variables.leaf.radiation
+   :members:
+
+Water Vapour
+~~~~~~~~~~~~
+
+.. automodule:: essm.variables.leaf.water_vapour
+   :members:
+
+Physics
+-------
+
+.. automodule:: essm.variables.physics.thermodynamics
+   :members:
+
+Units
+-----
+
+.. automodule:: essm.variables.units
+   :members:
+
+Equations
+=========
+
+.. automodule:: essm.equations
+
+Chamber
+-------
+
+.. automodule:: essm.equations.chamber
+
+Insulation
+~~~~~~~~~~
+
+.. automodule:: essm.equations.chamber.insulation
+   :members:
+
+Leaf
+----
+
+.. automodule:: essm.equations.leaf
+
+Energy Water
+~~~~~~~~~~~~
+
+.. automodule:: essm.equations.leaf.energy_water
+   :members:
+
+Physics
+-------
+
+.. automodule:: essm.equations.physics.thermodynamics
+   :members:

docs/index.rst

@@ -1,103 +1,42 @@
-.. ESSM documentation master file, created by
-   sphinx-quickstart on Tue May 16 14:29:58 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. include:: ../README.rst
 
-Welcome to ESSM's documentation!
-================================
+User's Guide
+============
+
+This part of the documentation will show you how to get started in using
+ESSM.
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
-
-FIXME: Example Plot
--------------------
-
-.. plot::
-
-   import matplotlib.pyplot as plt
-   import numpy as np
-   x = np.random.randn(1000)
-   plt.hist( x, 20)
-   plt.grid()
-   plt.title(r'Normal: $\mu=%.2f, \sigma=%.2f$'%(x.mean(), x.std()))
-   plt.show()
-
-
-Variables
-=========
-
-Chamber
--------
-
-Mass
-~~~~
-
-.. automodule:: essm.variables.chamber.mass
-   :members:
-
-Insulation
-~~~~~~~~~~
-
-.. automodule:: essm.variables.chamber.insulation
-   :members:
 
-Leaf
-----
+   installation
+   usage
 
-Radiation
-~~~~~~~~~
+API Reference
+=============
 
-.. automodule:: essm.variables.leaf.radiation
-   :members:
+If you are looking for information on a specific function, class or method,
+this part of the documentation is for you.
 
-Water Vapour
-~~~~~~~~~~~~
-
-.. automodule:: essm.variables.leaf.water_vapour
-   :members:
-
-Physics
--------
-
-.. automodule:: essm.variables.physics.thermodynamics
-   :members:
-
-Units
------
-
-.. automodule:: essm.variables.units
-   :members:
-
-Equations
-=========
-
-Chamber
--------
-
-Insulation
-~~~~~~~~~~
-
-.. automodule:: essm.equations.chamber.insulation
-   :members:
+.. toctree::
+   :maxdepth: 3
 
-Leaf
-----
+   api
 
-Energy Water
-~~~~~~~~~~~~
+Additional Notes
+================
 
-.. automodule:: essm.equations.leaf.energy_water
-   :members:
+Notes on how to contribute, legal information and changes are here for the
+interested.
 
-Physics
--------
+.. toctree::
+   :maxdepth: 1
 
-.. automodule:: essm.equations.physics.thermodynamics
-   :members:
+   license
+   ../AUTHORS
 
-.. rubric:: References
+References
+==========
 
 .. bibliography:: refs.bib
 

docs/installation.rst

@@ -0,0 +1,20 @@
+Installation
+============
+
+ESSM is on PyPI so all you need is:
+
+.. code-block:: console
+
+   $ sage -pip install essm
+
+Development
+-----------
+
+If you are planning to modify source code or generate new variables
+or equations, please install the package in development mode:
+
+.. code-block:: console
+
+   $ git clone https://github.com/environmentalscience/essm
+   $ cd environmental-science-for-sagemath
+   $ sage -pip install -e .

docs/license.rst

@@ -0,0 +1,4 @@
+License
+=======
+
+.. literalinclude:: ../LICENSE

docs/usage.rst

@@ -0,0 +1,4 @@
+Usage
+=====
+
+.. automodule:: essm