Skip to content
Snippets Groups Projects
README.md 2.29 KiB
Newer Older
# The mesoscale Hydrological Model -- mHM
Sebastian Müller's avatar
Sebastian Müller committed

- The current release is **[mHM v5.10][1]**.
- The latest mHM release notes can be found in the file [RELEASES][3] or [online][4].
- General information can be found on the [mHM website](http://www.ufz.de/mhm/).
- All the details of the code can be found in the [user manual][5].
- 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].
Sebastian Müller's avatar
Sebastian Müller committed

**Please note:** The [GitLab repository](https://git.ufz.de/mhm/mhm) grants read access to the code.
If you like to contribute to the code, please contact [mhm-admin@ufz.de](mailto:mhm-admin@ufz.de).
Sebastian Müller's avatar
Sebastian Müller committed

Sebastian Müller's avatar
Sebastian Müller committed

Please refer to the main model by citing Samaniego et al. (2010) and Kumar et al. (2013):
Sebastian Müller's avatar
Sebastian Müller committed

- 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
Sebastian Müller's avatar
Sebastian Müller committed

The model code can be cited as:
Sebastian Müller's avatar
Sebastian Müller committed

- **mHM:** Luis Samaniego et al. (2019), mesoscale Hydrologic Model, doi:10.5281/zenodo.1069202, https://doi.org/10.5281/zenodo.1069202
Sebastian Müller's avatar
Sebastian Müller committed

Sebastian Müller's avatar
Sebastian Müller committed

Please see the file [DEPENDENCIES][8] for external software required to run mHM.
See also the [users manual][5] for detailed instructions to setup mHM.
As from June 2019, new option to compile mHM with cmake is provided, see more details under [cmake manual][9].
## Quick start
Sebastian Müller's avatar
Sebastian Müller committed

1. Compile mHM with the `make` command, which uses settings from [Makefile](Makefile).
2. Run mHM on a test basin with the command `./mhm`, which uses settings from [mhm.nml](mhm.nml).
3. Explore the results in the [output directory](test_basin/), e.g. by using the NetCDF viewer `ncview`.
[1]: https://git.ufz.de/mhm/mhm/tree/5.10
[2]: https://git.ufz.de/mhm/mhm/repository/5.10/archive.zip
[3]: doc/RELEASES.md
[4]: https://git.ufz.de/mhm/mhm/tags/
[5]: doc/mhm_manual_v5.10.pdf
[6]: LICENSE
[7]: doc/mhm_papers.md
[8]: doc/DEPENDENCIES.md
[9]: INSTALL.md