Skip to content

Commit 5fdbdeb

Browse files
committed
reduce unnecessary text
1 parent 52cd63c commit 5fdbdeb

File tree

2 files changed

+16
-613
lines changed

2 files changed

+16
-613
lines changed

README.md

Lines changed: 14 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -28,55 +28,27 @@
2828
2929
The Hydrological Analysis Toolkit (HAT) is a software suite for hydrologists working with simulated and observed river discharge. HAT performs data analysis on hydrological datasets, with its main features being:
3030
- mapping station locations into hydrological model grids
31-
- extraction of timeseries
31+
- extraction of timeseries at station locations from gridded model outputs
3232
- statistical analysis of hydrological timeseries
3333

3434
### Installation
3535

36-
Clone source code repository
36+
For a default installation, run
3737

38-
$ git clone https://github.com/ecmwf/hat.git
39-
$ cd hat
40-
41-
Create and activate conda environment
42-
43-
$ conda create -n hat python=3.10
44-
$ conda activate hat
45-
46-
For default installation, run
47-
48-
$ pip install .
49-
50-
For a developer installation (includes linting and test libraries), run
51-
52-
$ pip install -e .[dev]
53-
$ pre-commit install
54-
55-
If you only plan to run the tests, instead run
56-
57-
$ pip install -e .[test]
58-
59-
If you plan to build a source and a wheel distribution, it is additionally required to run
60-
61-
$ pip install build
62-
63-
### Usage
64-
65-
Run a command line tool
66-
67-
$ hat-extract-timeseries --help
68-
69-
### Running the tests
70-
71-
Tests are stored in the `tests/` folder and can be run with
72-
73-
$ pytest
74-
75-
### Deployment
38+
```
39+
pip install hydro-analysis-toolkit
40+
```
7641

77-
To build a source and a wheel distribution, run
42+
For a developer setup, run
7843

79-
$ python build
44+
```
45+
conda create -n hat python=3.12
46+
conda activate hat
47+
git clone https://github.com/ecmwf/hat.git
48+
cd hat
49+
pip install -e .[dev]
50+
pre-commit install
51+
```
8052

8153
## Licence
8254

0 commit comments

Comments
 (0)