Skip to content

Commit ad5423f

Browse files
authored
Merge pull request #777 from uaf-arctic-eco-modeling/iss-776-podman-instructions
Add note to readme and documentation about using Podman.
2 parents de5483c + 805c78e commit ad5423f

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ command line.
2929

3030
More details are available in the [User Guide - Basic Model Setup and Run](https://uaf-arctic-eco-modeling.github.io/dvm-dos-tem/examples_and_tutorials/basic_model_run.html#basic-model-setup-and-run).
3131

32+
> [!TIP]
33+
> These instructions should work for users with [Podman](https://podman.io)
34+
> rather than Docker, but several additional steps may be necessary to ensure
35+
> that Podman can run with non-root access. See this
36+
> [issue](https://github.com/uaf-arctic-eco-modeling/dvm-dos-tem/issues/776)
37+
> for more information.
38+
3239
The settings shown here will use the input data that is shipped with the code in the
3340
repository's ``demo-data/`` directory. The run will output a single variable (GPP),
3441
and will run for 2 pixels.

docs_src/sphinx/source/examples_and_tutorials/basic_model_run.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ and visualization, see the :ref:`Plotting Example
2020
For users who have Docker and Git installed and some familiarity with the
2121
command line.
2222

23+
.. note::
24+
25+
These instructions should work for users with `Podman <https://podman.io>`_
26+
rather than Docker, but several additional steps may be necessary to ensure
27+
that Podman can run with non-root access. See this
28+
`issue <https://github.com/uaf-arctic-eco-modeling/dvm-dos-tem/issues/776>`_
29+
for more information.
30+
31+
2332
The settings shown here will use the input data that is shipped with the code
2433
in the repository's ``demo-data/`` directory. The run will output a single
2534
variable (GPP), and will run for 2 pixels.
@@ -148,6 +157,14 @@ The dependencies for a piece of software are isolated inside the container. This
148157
isolation allows software with conflicting dependencies to run on the host
149158
system.
150159

160+
.. hint::
161+
162+
These instructions should work for users with `Podman <https://podman.io>`_
163+
rather than Docker, but several additional steps may be necessary to ensure
164+
that Podman can run with non-root access. See this
165+
`issue <https://github.com/uaf-arctic-eco-modeling/dvm-dos-tem/issues/776>`_
166+
for more information.
167+
151168
There are other ways you can get the environment necessary for running,
152169
compiling and developing ``dvmdostem``, such as a native installation, or using
153170
a virtual machine (e.g. with Vagrant and Virtual Box or VMWare). Each path to a

0 commit comments

Comments
 (0)