README.md 2.27 KB
Newer Older
1
2
# The mesoscale Hydrological Model -- mHM

3
4
- The latest mHM release can be found [here][0].
- The changelog can be found in the file [RELEASES][3].
Sebastian Müller's avatar
Sebastian Müller committed
5
- General information can be found on the [mHM website](https://mhm-ufz.org/).
6
7
8
- The mHM comes with a [LICENSE][6] agreement, this includes also the GNU Lesser General Public License.
- There is a list of [publications using mHM][7].

9
**Please note:** The [GitLab repository](https://git.ufz.de/mhm/mhm) grants read access to the code.
10
If you like to contribute to the code, please contact [mhm-admin@ufz.de](mailto:mhm-admin@ufz.de).
11

12
13
14
15
## Documentation

The online documentation for mHM can be found here (pdf versions are provided there as well):
- stable: https://mhm.pages.ufz.de/mhm
16
- latest: https://mhm.pages.ufz.de/mhm/latest
17

18
19
20
21
## Cite as

Please refer to the main model by citing Samaniego et al. (2010) and Kumar et al. (2013):

22
23
24
> Samaniego L., R. Kumar, S. Attinger (2010): Multiscale parameter regionalization of a grid-based hydrologic model at the mesoscale. Water Resour. Res., 46,W05523, doi:10.1029/2008WR007327, http://onlinelibrary.wiley.com/doi/10.1029/2008WR007327/abstract

> Kumar, R., L. Samaniego, and S. Attinger (2013): Implications of distributed hydrologic model parameterization on water fluxes at multiple scales and locations, Water Resour. Res., 49, doi:10.1029/2012WR012195, http://onlinelibrary.wiley.com/doi/10.1029/2012WR012195/abstract
25

26
The model code can be generally cited as:
27

28
29
> **mHM:** Luis Samaniego et al., mesoscale Hydrologic Model. Zenodo. doi:10.5281/zenodo.1069202, https://doi.org/10.5281/zenodo.1069202

Sebastian Müller's avatar
Sebastian Müller committed
30
To cite a certain version, have a look at the [Zenodo site][10].
31
32
33

## Install

34
mHM can be compiled with cmake. See more details under [cmake manual][9].
35
See also the [documentation][5] for detailed instructions to setup mHM.
36
37


38
39
## Quick start

40
41
42
1. Compile mHM
2. Run mHM on the test domains with the command `./mhm`, which uses settings from [mhm.nml](mhm.nml).
3. Explore the results in the [output directory](test_domain/), e.g. by using the NetCDF viewer `ncview`.
43

44
[0]: https://git.ufz.de/mhm/mhm/-/releases
45
46
[3]: doc/RELEASES.md
[4]: https://git.ufz.de/mhm/mhm/tags/
47
[5]: https://mhm.pages.ufz.de/mhm
48
[6]: LICENSE
Sebastian Müller's avatar
Sebastian Müller committed
49
[7]: https://mhm-ufz.org/about/publications/
Sebastian Müller's avatar
Sebastian Müller committed
50
[9]: doc/INSTALL.md
51
[10]: https://zenodo.org/record/3239055