mhm.download Namespace Reference

Download routines to get test domains for mHM. More...

Functions
	_dl (branch, format, folder, filename)
	download_test (branch=None, domain=1, path=None, verbose=False)
	Download a test domain for mHM.
	cli (argv=None)
	Command line interface to download test domains for mHM.

Variables
str	MHM_URL = "https://git.ufz.de/mhm/mhm/-/archive/{branch}/mhm-{branch}.{format}{query}"
dict	BRANCH_MAP = {"main": "develop", "develop": "main"}
list	VALID_DOMAINS = [1, 2]

Detailed Description

Download routines to get test domains for mHM.

Copyright

Copyright 2005-2024, the mHM Developers, Luis Samaniego, Sabine Attinger: All rights reserved. mHM is released under the LGPLv3+ license

The UFZ(CHS) mesoscale hydrologic model mHM is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the free Software Foundation either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You received a copy of the GNU Lesser General Public License along with the UFZ CHS mesoscale hydrologic model mHM. It can be found in the files COPYING and COPYING.LESSER provided with this software. The complete GNU license text can also be found at http://www.gnu.org/licenses/.

Function Documentation

_dl()

mhm.download._dl (   branch,   format,   folder,   filename  )

protected

Definition at line 25 of file download.py.

Referenced by mhm.download.download_test().

Here is the caller graph for this function:

cli()

mhm.download.cli

(

argv = None

)

Command line interface to download test domains for mHM.

Definition at line 76 of file download.py.

download_test()

mhm.download.download_test	(		branch = None,
			domain = 1,
			path = None,
			verbose = False
	)

Download a test domain for mHM.

Parameters

branch	(str, optional): Branch, tag, or commit of the mHM repository to take the test domain from, by default tag determined from the mHM version
domain	(int, optional): Test domain 1 or 2, by default 1
path	(pathlike, optional): Destination path for the downloaded folder, by default original name of the test domain folder

Definition at line 30 of file download.py.

References mhm.download._dl().

Here is the call graph for this function:

Variable Documentation

BRANCH_MAP

dict mhm.download.BRANCH_MAP = {"main": "develop", "develop": "main"}

Definition at line 21 of file download.py.

MHM_URL

str mhm.download.MHM_URL = "https://git.ufz.de/mhm/mhm/-/archive/{branch}/mhm-{branch}.{format}{query}"

Definition at line 19 of file download.py.

VALID_DOMAINS

list mhm.download.VALID_DOMAINS = [1, 2]

Definition at line 22 of file download.py.