Skip to content

Commit

Permalink
changed README format (md to rst) and add doc badge
Browse files Browse the repository at this point in the history
  • Loading branch information
benbovy committed Jun 13, 2017
1 parent 2811047 commit 1c8696a
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 24 deletions.
24 changes: 0 additions & 24 deletions README.md

This file was deleted.

36 changes: 36 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
xarray-simlab: xarray extension for computer model simulations
==============================================================

|Doc Status|

xarray-simlab is a Python library that provides both a framework for creating
computational models from re-usable components and a xarray_ extension for
setting and running simulations using the xarray's ``Dataset`` structure.

**Warning: this package is currently under heavy development (no stable release yet).**

.. _xarray: http://xarray.pydata.org
.. |Doc Status| image:: http://readthedocs.org/projects/xarray-simlab/badge/?version=latest
:target: http://xarray-simlab.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

Documentation
-------------

A draft of documentation is hosted on ReadTheDocs: http://xarray-simlab.readthedocs.io

License
-------

3-clause ("Modified" or "New") BSD license,
see `License file <https://github.com/benbovy/xarray-simlab/blob/master/LICENSE>`__.

xarray-simlab is developped at the `Earth Surface Process Modelling`_
group of the GFZ Helmholtz Centre Potsdam.

xarray-simlab uses short parts of the code of the xarray_, pandas_ and dask_
libraries. Their licenses are reproduced in the "licenses" directory.

.. _`Earth Surface Process Modelling`: http://www.gfz-potsdam.de/en/section/earth-surface-process-modelling/
.. _pandas: http://pandas.pydata.org/
.. _dask: http://dask.pydata.org

0 comments on commit 1c8696a

Please sign in to comment.