Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mazweg committed Mar 14, 2018
1 parent f7402cf commit c93f249
Showing 1 changed file with 35 additions and 5 deletions.
40 changes: 35 additions & 5 deletions README.rst
Expand Up @@ -14,10 +14,21 @@ smap_io
.. image:: https://zenodo.org/badge/12761/TUW-GEO/smap_io.svg
:target: https://zenodo.org/badge/latestdoi/12761/TUW-GEO/smap_io

.. image:: https://readthedocs.org/projects/smap_io/badge/?version=latest
:target: http://smap_io.readthedocs.org/

SMAP (Soil Moisture Active Passive) data readers.

Works great in combination with `pytesmo <https://github.com/TUW-GEO/pytesmo>`_.

Citation
========

If you use the software in a publication then please cite it using the Zenodo DOI:

.. image:: https://zenodo.org/badge/12761/TUW-GEO/smap_io.svg
:target: https://zenodo.org/badge/latestdoi/12761/TUW-GEO/smap_io

Installation
============

Expand All @@ -36,11 +47,30 @@ Supported Products

- `SPL3SMP <http://nsidc.org/data/SPL3SMP>`_: SMAP L3 Radiometer Global Daily 36 km EASE-Grid Soil Moisture

Documentation
=============
Contribute
==========

We are happy if you want to contribute. Please raise an issue explaining what
is missing or if you find a bug. We will also gladly accept pull requests
against our master branch for new features or bug fixes.

Development setup
-----------------

For Development we also recommend the ``conda`` environment from the
installation part.

Guidelines
----------

If you want to contribute please follow these steps:

- Fork the smap_io repository to your account
- make a new feature branch from the smap_io master branch
- Add your feature
- please include tests for your contributions in one of the test directories
We use py.test so a simple function called test_my_feature is enough
- submit a pull request to our master branch

|Documentation Status|

.. |Documentation Status| image:: https://readthedocs.org/projects/smap_io/badge/?version=latest
:target: http://smap_io.readthedocs.org/

0 comments on commit c93f249

Please sign in to comment.