Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Each system is a different object inside the ``systems`` section.
In our example we define three systems, a Mac laptop, Piz Daint and a generic fallback system:

.. literalinclude:: ../tutorials/config/settings.py
:lines: 11-89
:lines: 11-90

Each system is associated with a set of properties, which in this case are the following:

Expand All @@ -90,7 +90,7 @@ The ``login`` partition refers to the login nodes of the system, whereas the ``g
Let's pick the ``gpu`` partition and look into it in more detail:

.. literalinclude:: ../tutorials/config/settings.py
:lines: 38-58
:lines: 39-59

The basic properties of a partition are the following:

Expand Down Expand Up @@ -132,7 +132,7 @@ In our example, we define environments for all the basic compilers as well as a
In certain contexts, it is useful to see a ReFrame environment as a wrapper of a programming toolchain (MPI + compiler combination):

.. literalinclude:: ../tutorials/config/settings.py
:lines: 90-148
:lines: 91-149

Each environment is associated with a name.
This name will be used to reference this environment in different contexts, as for example in the ``environs`` property of the system partitions.
Expand All @@ -154,7 +154,7 @@ Additionally, it allows for logging performance data from performance tests into
Let's see how logging is defined in our example configuration, which also represents a typical one for logging:

.. literalinclude:: ../tutorials/config/settings.py
:lines: 149-184
:lines: 150-185

Logging is configured under the ``logging`` section of the configuration, which is a list of logger objects.
Unless you want to configure logging differently for different systems, a single logger object is enough.
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial_advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ You can then use those resources transparently from within your test.
To achieve this in our case, we first need to define a ``memory`` resource in the configuration:

.. literalinclude:: ../tutorials/config/settings.py
:lines: 30-51,58-74
:lines: 31-52,59-75
:emphasize-lines: 17-22,32-38

Notice that we do not define the resource for all the partitions, but only for those that it makes sense.
Expand Down Expand Up @@ -707,7 +707,7 @@ ReFrame can be used also to test applications that run inside a container.
First, we need to enable the container platform support in ReFrame's configuration and, specifically, at the partition configuration level:

.. literalinclude:: ../tutorials/config/settings.py
:lines: 38-62
:lines: 39-63
:emphasize-lines: 15-24

For each partition, users can define a list of container platforms supported using the :js:attr:`container_platforms` `configuration parameter <config_reference.html#.systems[].partitions[].container_platforms>`__.
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorial_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,8 @@ Note that you should *not* edit this configuration file in place.
Here is how the new configuration file looks like with the needed additions highlighted:

.. literalinclude:: ../tutorials/config/settings.py
:lines: 10-24,80-101,134-
:emphasize-lines: 3-15,31-42
:lines: 10-25,81-102,135-
:emphasize-lines: 3-16,32-43

Here we define a system named ``catalina`` that has one partition named ``default``.
This partition makes no use of any `workload manager <config_reference.html#.systems[].partitions[].scheduler>`__, but instead launches any jobs locally as OS processes.
Expand Down Expand Up @@ -809,8 +809,8 @@ Let's extend our configuration file for Piz Daint.


.. literalinclude:: ../tutorials/config/settings.py
:lines: 10-45,62-70,77-
:emphasize-lines: 16-48,70-101,114-120
:lines: 10-46,63-71,78-
:emphasize-lines: 17-49,71-102,115-121


First of all, we need to define a new system and set the list of hostnames that will help ReFrame identify it.
Expand Down
1 change: 1 addition & 0 deletions tutorials/config/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
'name': 'catalina',
'descr': 'My Mac',
'hostnames': ['tresa'],
'modules_system': 'nomod',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'modules_system' is not required and it defaults to 'nomod', so I think this should not be included in here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that is true, but a user of the tutorials typically doesn't know that. They probably don't even know that that setting up modules is a thing they might want to do (see #1887) but by being mildly redundant they might get the clue that if they want modules support then they need to set things up.

If util.find_modules gave an error when modules_system was nomod then there'd have been a way to find out that my problem lay in configuration, and not in invalid construction of my test parameters.

The next example configuration on daint does have modules_system, but also a lot of partition complexity. When I read the docs, I knew I didn't need the latter for running on my dedicated node, so never saw that the example for modules_system was also mentioned there.

There is text lower down that mentions modules_system but it's a bit buried in a section about partitions, so again I missed it.

'partitions': [
{
'name': 'default',
Expand Down