Version 0.2

Description

This tool is a generic moving window - dispersion function / variogram calculation tool,
implemented as a gernalized version of Mälicke et al. (2020).

Mälicke, M., Hassler, S. K., Blume, T., Weiler, M., & Zehe, E. (2020). Soil moisture: variable in space but redundant in time. Hydrology and Earth System Sciences, 24(5), 2633-2653.

It is part of the V-FOR-WaTer processing toolbox, but can also be run independently.

How to run?

This template installs the json2args python package to parse the parameters in the /in/parameters.json. This assumes that
the files are not renamed and not moved and there is actually only one tool in the container. For any other case, the environment variables
PARAM_FILE can be used to specify a new location for the parameters.json and TOOL_RUN can be used to specify the tool to be executed.
The run.py has to take care of that.

To invoke the docker container directly run something similar to:

docker run --rm -it -v /path/to/local/in:/in -v /path/to/local/out:/out -e TOOL_RUN="convert-input" tbr_dispersion

Then, the output will be in your local out and based on your local input folder. Stdout and Stderr are also connected to the host.

With the toolbox runner, this is simplyfied:

from toolbox_runner import list_tools
tools = list_tools() # dict with tool names as keys

# make up some data
import numpy as np
positions = np.random.randint(10, 2, size=(300, 2))
series = np.random.random(5, 13, size=(300, 1500))

# static vario params
vario = dict(model='exponential', maxlag='mean', n_lags=25)

window = tools.get('moving-window')  # it has to be present there...
window.run(result_path='./', positions=positions, data=series, window_size=60, variogram=vario)

The example above will create a temporary file structure to be mounted into the container and then create a .tar.gz on termination of all
inputs, outputs, specifications and some metadata, including the image sha256 used to create the output in the current working directory.

What's Changed

• Adding Tutorials by @mmaelicke in #1

New Contributors

• @mmaelicke made their first contribution in #1

Full Changelog: v0.1.0...v0.2.0

Initial release

Initial release of the tool to test the pipeline. The official release will follow soon.

This tool is a generic moving window - dispersion function / variogram calculation tool,
implemented as a gernalized version of Mälicke et al. (2020).

Mälicke, M., Hassler, S. K., Blume, T., Weiler, M., & Zehe, E. (2020). Soil moisture: variable in space but redundant in time. Hydrology and Earth System Sciences, 24(5), 2633-2653.