Commit 46815248 authored by Philipp Sommer's avatar Philipp Sommer

Minor doc changes

parent 0bf6d8d5
......@@ -3,18 +3,48 @@ ravel-dataset: Simple script to ravel a netCDF dataset
======================================================
Installation with admin privileges
-----------------------------------
Installation and usage without admin privileges (e.g. on mistral)
-----------------------------------------------------------------
Installation
############
```bash
python -m pip install ./
python -m pip install git+https://coastgit.hzg.de/Chilipp/ravel-dataset.git
```
Usage
#####
```bash
python -m ravel_ds infile.nc outfile.nc
```
Installation and usage without admin privileges
------------------------------------------------
Installation and usage with admin privileges
--------------------------------------------
Installation
############
```bash
python -m pip install git+https://coastgit.hzg.de/Chilipp/ravel-dataset.git
```
Usage
#####
```bash
python -m pip install --user ./
ravel-ds infile.nc outfile.nc
```
This will ravel all dimensions in the netCDF file. If you only want to ravel
the dimensions of a certain variable, use
```bash
ravel-ds infile.nc outfile.nc -v <variable-name>
```
Requirements
------------
This package depends on xarray_ and netCDF4_.
.. _xarray: https://xarray.pydata.org
.. _netCDF4: https://github.com/Unidata/netcdf4-python
"""Script to ravel variables in a netCDF file
Usage:
python ravel_ds.py infile outfile
# access the help:
python ravel_ds.py -h
"""
import xarray as xr
import argparse
from itertools import chain
__version__ = "1.0.0"
__author__ = "Philipp S. Sommer"
__copyright__ = "Copyright 2020, HZG"
__email__ = "philipp.sommer@hzg.de"
__status__ = "Production"
__license__ = "GPLv3"
def main():
parser = get_parser()
args = parser.parse_args()
......
......@@ -43,7 +43,7 @@ setup(name='ravel-dataset',
'Operating System :: OS Independent',
],
keywords='netcdf raster earth-sciences',
url='https://github.com/psyplot/psyplot',
url='https://coastgit.hzg.de/Chilipp/ravel-dataset',
author='Philipp Sommer',
author_email='philipp.sommer@hzg.de.ch',
license="GPLv3",
......
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