Skip to content

Commit

Permalink
Code styling (#27)
Browse files Browse the repository at this point in the history
* Update docs

* Update docs and meta package

* Update docs and meta package

* Code styling
  • Loading branch information
wpreimes authored Aug 30, 2024
1 parent 919ec5d commit e98197b
Show file tree
Hide file tree
Showing 9 changed files with 591 additions and 370 deletions.
36 changes: 12 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,28 @@
c3s_sm
============

|ci| |cov| |pip| |doc|

.. image:: https://github.com/TUW-GEO/c3s_sm/workflows/Automated%20Tests/badge.svg?branch=master
.. |ci| image:: https://github.com/TUW-GEO/c3s_sm/actions/workflows/ci.yml/badge.svg?branch=master
:target: https://github.com/TUW-GEO/c3s_sm/actions

.. image:: https://coveralls.io/repos/github/TUW-GEO/c3s_sm/badge.svg?branch=master
:target: https://coveralls.io/github/TUW-GEO/c3s_sm?branch=master
.. |cov| image:: https://coveralls.io/repos/TUW-GEO/c3s_sm/badge.png?branch=master
:target: https://coveralls.io/r/TUW-GEO/c3s_sm?branch=master

.. |pip| image:: https://badge.fury.io/py/c3s_sm.svg
:target: http://badge.fury.io/py/c3s-sm

.. |doc| image:: https://readthedocs.org/projects/c3s_sm/badge/?version=latest
:target: http://c3s-sm.readthedocs.org/

.. image:: https://badge.fury.io/py/c3s-sm.svg
:target: https://badge.fury.io/py/c3s-sm

.. image:: https://readthedocs.org/projects/c3s_sm/badge/?version=latest
:target: https://c3s-sm.readthedocs.io/en/latest/

Processing tools and tutorials for users of the C3S satellite soil moisture
service ( https://doi.org/10.24381/cds.d7782f18 ). Written in Python.

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

The c3s_sm package can be installed via
The c3s_sm package and all required dependencies can be installed via

.. code-block:: shell
Expand All @@ -30,7 +32,7 @@ The c3s_sm package can be installed via
Tutorials
=========

We provide (general) tutorials on using the C3S Soil Moisture data:
We provide tutorials on using the C3S Soil Moisture data:

- `Tutorial 1: DataAccess from CDS & Anomaly computation <https://c3s-sm.readthedocs.io/en/latest/T1_DataAccess_Anomalies.html>`_

Expand All @@ -52,14 +54,6 @@ 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 a ``conda`` environment. You can create one
including test dependencies and debugger by running
``conda env create -f environment.yml``. This will create a new ``c3s_sm``
environment which you can activate by using ``source activate c3s_sm``.

Guidelines
----------

Expand All @@ -71,11 +65,5 @@ If you want to contribute please follow these steps:
- make a new feature branch from the c3s_sm 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

Note
====

This project has been set up using PyScaffold 2.5. For details and usage
information on PyScaffold see http://pyscaffold.readthedocs.org/.
5 changes: 5 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,8 @@ version = 4.5
package = c3s_sm
extensions =
no_skeleton

[yapf]
based_on_style = yapf
indent_width = 4
column_limit = 79
Loading

0 comments on commit e98197b

Please sign in to comment.