From 0b467a36218f25cdf1f0c8b04d2e25ecc7316177 Mon Sep 17 00:00:00 2001 From: SarahAlidoost Date: Fri, 27 Sep 2024 16:15:05 +0200 Subject: [PATCH] update the version of docker image --- Dockerfile | 2 +- PyStemmusScope/bmi/docker_process.py | 2 +- docs/bmi.md | 6 +++--- tests/test_data/config_file_docker.txt | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Dockerfile b/Dockerfile index 58216034..eaf7b8b1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM ghcr.io/ecoextreml/stemmus_scope:1.6.0 +FROM ghcr.io/ecoextreml/stemmus_scope:1.6.1 LABEL maintainer="Bart Schilperoort " LABEL org.opencontainers.image.source = "https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing" diff --git a/PyStemmusScope/bmi/docker_process.py b/PyStemmusScope/bmi/docker_process.py index 7e0cc220..ab65f3e5 100644 --- a/PyStemmusScope/bmi/docker_process.py +++ b/PyStemmusScope/bmi/docker_process.py @@ -83,7 +83,7 @@ class StemmusScopeDocker: """Communicate with a STEMMUS_SCOPE Docker container.""" # Default image, can be overridden with config: - compatible_tags = ("1.6.0",) + compatible_tags = ("1.6.1",) _process_ready_phrase = b"Select BMI mode:" _process_finalized_phrase = b"Finished clean up." diff --git a/docs/bmi.md b/docs/bmi.md index 13243b17..c47ede7a 100644 --- a/docs/bmi.md +++ b/docs/bmi.md @@ -19,10 +19,10 @@ To use the Docker image, use the `DockerImage` setting in the configuration file ```sh WorkDir=/home/username/tmp/stemmus_scope ... -DockerImage=ghcr.io/ecoextreml/stemmus_scope:1.6.0 +DockerImage=ghcr.io/ecoextreml/stemmus_scope:1.6.1 ``` -It is best to add the version tag here too (`:1.6.0`), this way the BMI will warn you if the version might be incompatible. +It is best to add the version tag here too (`:1.6.1`), this way the BMI will warn you if the version might be incompatible. Note that the `docker` package for python is required here. Install this with `pip install PyStemmusScope[docker]`. Additionally, [Docker](https://docs.docker.com/get-docker/) itself has to be installed. @@ -52,7 +52,7 @@ If you need access to other model variables that are not yet available in the BM A [Docker image is available](https://ghcr.io/ecoextreml/stemmus_scope-grpc4bmi) in which the model as well as the Python BMI have been wrapped in a container. The Docker image is created using the Docker file [here](https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing/blob/main/Dockerfile) and allows communication with a STEMMUS_SCOPE BMI through [grpc4bmi](https://grpc4bmi.readthedocs.io/en/latest/). -Doing so avoids the needs to install PyStemmusScope yourself, only Docker/apptainer and a python environment with grpc4bmi are required. Please note you should not specify `DockerImage` or `ExeFilePath` in the config file if you are using the grpc4bmi interface. +Doing so avoids the needs to install PyStemmusScope yourself, only Docker/apptainer and a python environment with grpc4bmi are required. Please note you should not specify `DockerImage` or `ExeFilePath` in the config file if you are using the grpc4bmi interface. A demonstration is available [here](notebooks/grpc4bmi_demo.ipynb) diff --git a/tests/test_data/config_file_docker.txt b/tests/test_data/config_file_docker.txt index df00ba25..5a26ed34 100644 --- a/tests/test_data/config_file_docker.txt +++ b/tests/test_data/config_file_docker.txt @@ -13,4 +13,4 @@ StartTime=1996-01-01T00:00 EndTime=1996-01-01T02:00 InputPath= OutputPath= -DockerImage=ghcr.io/ecoextreml/stemmus_scope:1.6.0 \ No newline at end of file +DockerImage=ghcr.io/ecoextreml/stemmus_scope:1.6.1