Skip to content

[doc] Fix syntax of container tutorial example #1008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vkarak merged 2 commits into from
Oct 25, 2019
Merged

[doc] Fix syntax of container tutorial example #1008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60b54fd
Fix syntax of container tutorial example
Oct 24, 2019
153105b
Merge branch 'master' into doc/fix-container-example
Oct 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ The following example shows a simple test that runs some basic commands inside a
A container-based test in ReFrame requires that the :attr:`container_platform <reframe.core.pipeline.RegressionTest.container_platform>` is set:

.. literalinclude:: ../tutorial/advanced/advanced_example10.py
:lines: 13
:lines: 12

This attribute accepts a string that corresponds to the name of the platform and it instantiates the appropriate :class:`ContainerPlatform <reframe.core.containers.ContainerPlatform>` object behind the scenes.
In this case, the test will be using `Singularity <https://sylabs.io>`__ as a container platform.
Expand All @@ -475,7 +475,7 @@ For a complete list of supported container platforms, the user is referred to th
As soon as the container platform to be used is defined, you need to specify the container image to use and the commands to run inside the container:

.. literalinclude:: ../tutorial/advanced/advanced_example10.py
:lines: 14-17
:lines: 13-16

These two attributes are mandatory for container-based check.
The :attr:`image <reframe.core.pipeline.RegressionTest.container_platform.image>` attribute specifies the name of an image from a registry, whereas the :attr:`commands <reframe.core.pipeline.RegressionTest.container_platform.commands>` attribute provides the list of commands to be run inside the container.
Expand All @@ -494,7 +494,7 @@ Once the commands are executed, the container is stopped and ReFrame goes on wit
Users may also change the default mount point of the stage directory by using :attr:`workdir <reframe.core.pipeline.RegressionTest.container_platform.workdir>` attribute:

.. literalinclude:: ../tutorial/advanced/advanced_example10.py
:lines: 18
:lines: 17

Besides the stage directory, additional mount points can be specified through the :attr:`mount_points <reframe.core.pipeline.RegressionTest.container_platform.mount_points>` attribute:

Expand Down
3 changes: 1 addition & 2 deletions tutorial/advanced/advanced_example10.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
@rfm.required_version('>=2.20-dev2')
@rfm.simple_test
class Example10Test(rfm.RunOnlyRegressionTest):
def __init__(self, **kwargs):
super().__init__()
def __init__(self):
self.descr = 'Run commands inside a container'
self.valid_systems = ['daint:gpu']
self.valid_prog_environs = ['PrgEnv-cray']
Expand Down