Commit 0ff88118 authored by Benoit Bovy's avatar Benoit Bovy
Browse files

change README format (md to rst) and add doc link

parent f47da189
# xarray-topo: xarray extension for topographic analysis and modelling
xarray-topo is a Python package that extends [xarray](http://xarray.pydata.org)
with a small set of topographic tools useful for processing Digital Elevation
Models (DEMs) and/or outputs of Landscape Evolution Models (LEMs).
It also provides [xarray-simlab](https://github.com/benbovy/xarray-simlab)
compatible models and re-usable model components (i.e., processes) for landscape
evolution modelling.
**Warning: this package is currently under heavy development (no stable release yet).**
## License
3-clause ("Modified" or "New") BSD license (see [License file](LICENSE)).
xarray-topo is developped at the
[Earth Surface Process Modelling](http://www.gfz-potsdam.de/en/section/earth-surface-process-modelling/)
group of the GFZ Helmholtz Centre Potsdam.
xarray-topo: xarray extension for topographic analysis and modelling
====================================================================
|Doc Status|
xarray-topo is a Python package that extends xarray_ with a small set of
topographic tools useful for processing Digital Elevation Models (DEMs) and/or
outputs of Landscape Evolution Models (LEMs).
It also provides `xarray-simlab`_ compatible models and re-usable model
components (i.e., processes) for landscape evolution modelling.
**Warning: this package is currently under heavy development (no stable release yet).**
.. _xarray: http://xarray.pydata.org
.. _`xarray-simlab`: http://xarray-simlab.readthedocs.io
.. |Doc Status| image:: https://readthedocs.org/projects/xarray-topo/badge/?version=latest
:target: http://xarray-topo.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Documentation
-------------
A draft of documentation is hosted on ReadTheDocs: http://xarray-topo.readthedocs.io
License
-------
3-clause ("Modified" or "New") BSD license
see `License file <https://gitext.gfz-potsdam.de/sec55-public/xarray-topo/blob/master/LICENSE>`__.
xarray-topo is developped at the `Earth Surface Process Modelling`_
group of the GFZ Helmholtz Centre Potsdam.
.. _`Earth Surface Process Modelling`: http://www.gfz-potsdam.de/en/section/earth-surface-process-modelling/
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment