Commit ea7beaae authored by Eva Börgens's avatar Eva Börgens
Browse files

update README

parent 175db2f9
......@@ -2,7 +2,23 @@
Python tool box, which allows the user to calculate mean TWS time series,
their uncertainties, and regional covariance matrices for arbitrary regions.
## usage:
## Install
The script comes with a predefined Python environment, which is managed by [pipenv](
The environment handles all dependencies.
Please clone this repository and install the [environment and the dependencies](Pipfile) as follows:
# in case you do not have installed pipenv
pip install pipenv
git clone ...
cd regional-tws-uncertainty
pipenv install
## Usage:
sh [-h] -f FILENAME -r REGION -o OUTPUT [-m] [-u] [-t]
......@@ -40,4 +56,16 @@ From gridded mask stored in netcdf (region=1, else=0), requires cdo:
From outline polygone, requires cdo and GMT :
cdo gmtxyz FILENAME| gmt select -Fpolygone.txt | cut -f 1,2> region.gmt
\ No newline at end of file
cdo gmtxyz FILENAME| gmt select -Fpolygone.txt | cut -f 1,2> region.gmt
Two examples for region files can be found in /example_data
## Citation Hint
If you use this work in a research publication, please cite the specific version using the [citation metadata](CITATION.cff).
Please see the [CHANGELOG]( for the details of the different versions.
## License
Copyright © 2021 [Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences Potsdam, Germany](
Markdown is supported
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