|
28 | 28 |
|
29 | 29 | 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: |
30 | 30 | - mapping station locations into hydrological model grids |
31 | | -- extraction of timeseries |
| 31 | +- extraction of timeseries at station locations from gridded model outputs |
32 | 32 | - statistical analysis of hydrological timeseries |
33 | 33 |
|
34 | 34 | ### Installation |
35 | 35 |
|
36 | | -Clone source code repository |
| 36 | +For a default installation, run |
37 | 37 |
|
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 | +``` |
76 | 41 |
|
77 | | -To build a source and a wheel distribution, run |
| 42 | +For a developer setup, run |
78 | 43 |
|
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 | +``` |
80 | 52 |
|
81 | 53 | ## Licence |
82 | 54 |
|
|
0 commit comments