Skip to content

Commit 80aa756

Browse files
committed
add note about --container-tech to getting started docs
Signed-off-by: vsoch <[email protected]>
1 parent b0c24a8 commit 80aa756

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

docs/getting_started/user-guide.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,8 @@ commands. Aliases that are custom to the container are not modified.
330330
Module Software
331331
===============
332332

333-
The default module software is currently LMOD, and there is also support for tcl. If you
333+
The default module software is currently LMOD, and there is also support for environment
334+
modules that only use tcl (tcl). If you
334335
are interested in adding another module type, please `open an issue <https://github.com/singularityhub/singularity-hpc>`_ and
335336
provide description and links to what you have in mind. You can either specify the
336337
module software on the command line:
@@ -348,7 +349,22 @@ or you can set the global variable to what you want to use (it defaults to lmod)
348349
$ shpc config set module_sys:tcl
349350
350351
351-
The command line argument, if provided, always over-rides the default.
352+
The command line argument, if provided, always over-rides the default. The
353+
same works for the container technology. Here is how to install with a different
354+
container technology, podman, either for a one-off command:
355+
356+
.. code-block:: console
357+
358+
$ shpc install --container-tech podman python
359+
360+
361+
or for a global setting:
362+
363+
.. code-block:: console
364+
365+
$ shpc config set container_tech:podman
366+
367+
352368
353369
Container Technology
354370
====================

shpc/client/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ def get_parser():
227227
default=None,
228228
)
229229
command.add_argument(
230-
"--container_tech",
230+
"--container-tech",
231231
dest="container_tech",
232232
help="container technology to use to override settings.yaml",
233233
choices=["singularity", "podman"],

0 commit comments

Comments
 (0)