Skip to content

Commit 177b897

Browse files
Improve the documentation on the docker images/files.
Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>
1 parent 565c0c8 commit 177b897

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

docs/bmi.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For more information on each method, see the sections below.
1313

1414
### Dockerized executable
1515
STEMMUS_SCOPE has a Docker image available. This allows you to run the executable file without having to install MCR.
16-
The Docker image is available at https://ghcr.io/ecoextreml/stemmus_scope
16+
The Docker image is available at https://ghcr.io/ecoextreml/stemmus_scope. The Docker image is created using the docker file [here](https://github.com/EcoExtreML/STEMMUS_SCOPE/blob/main/Dockerfile).
1717

1818
To use the Docker image, use the `DockerImage` setting in the configuration file:
1919
```sh
@@ -50,10 +50,9 @@ If you need access to other model variables that are not yet available in the BM
5050

5151
## grpc4bmi
5252

53-
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.
54-
This allows communication with a STEMMUS_SCOPE BMI through [grpc4bmi](https://grpc4bmi.readthedocs.io/en/latest/).
53+
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/).
5554

56-
Doing so avoids the needs to install PyStemmusScope yourself, only Docker/apptainer and a python environment with grpc4bmi are required.
55+
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.
5756

5857
A demonstration is available [here](notebooks/grpc4bmi_demo.ipynb)
5958

@@ -84,4 +83,4 @@ Lastly you have to update the `get_variable` and `set_variable` functions in `Py
8483
Here you define how the python code can access them.
8584
While writing the code you can inspect the state using `model.state`, which allows you to view the full contents of the HDF5 file for easier debugging.
8685

87-
When you release a new Docker image that is compatible with the new BMI implementation, you need to update the `compatible_tags` variable of the class `StemmusScopeDocker` in `PyStemmusScope/bmi/docker_process.py`.
86+
After implementing the BMI changes, a new [STEMMUS_SCOPE Docker image](https://github.com/EcoExtreML/STEMMUS_SCOPE/pkgs/container/stemmus_scope) should be released that is compatible with the new BMI implementation. A new release usually includes a new tag. Then, you need to update the `compatible_tags` variable of the class `StemmusScopeDocker` in `PyStemmusScope/bmi/docker_process.py`.

0 commit comments

Comments
 (0)