Skip to content

[bugfix] Fix 'site_configuration' in docs #344

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
merged 2 commits into from
Jun 28, 2018
Merged

[bugfix] Fix 'site_configuration' in docs #344

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
913c578
[bugfix] Fix 'site_configuration' in docs
Jun 22, 2018
2a1c609
Merge branch 'master' into bugfix/site_conf_documentation
vkarak Jun 28, 2018
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
10 changes: 5 additions & 5 deletions docs/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ As soon as a new system with its programming environments is configured, adaptin
The Configuration File
----------------------

The configuration of systems and programming environments is performed by a special Python dictionary called ``_site_configuration`` defined inside the file ``<install-dir>/reframe/settings.py``.
The configuration of systems and programming environments is performed by a special Python dictionary called ``site_configuration`` defined inside the file ``<install-dir>/reframe/settings.py``.

The ``_site_configuration`` dictionary should define two entries, ``systems`` and ``environments``.
The ``site_configuration`` dictionary should define two entries, ``systems`` and ``environments``.
The former defines the systems that ReFrame may recognize, whereas the latter defines the available programming environments.

The following example shows a minimal configuration for the `Piz Daint <https://www.cscs.ch/computers/piz-daint/>`__ supercomputer at CSCS:

.. code-block:: python

_site_configuration = {
site_configuration = {
'systems': {
'daint': {
'descr': 'Piz Daint',
Expand Down Expand Up @@ -134,7 +134,7 @@ The available partition attributes are the following:
* ``access``: A list of scheduler options that will be passed to the generated job script for gaining access to that logical partition (default ``[]``).

* ``environs``: A list of environments, with which ReFrame will try to run any regression tests written for this partition (default ``[]``).
The environment names must be resolved inside the ``environments`` section of the ``_site_configuration`` dictionary (see `Environments Configuration <#environments-configuration>`__ for more information).
The environment names must be resolved inside the ``environments`` section of the ``site_configuration`` dictionary (see `Environments Configuration <#environments-configuration>`__ for more information).

* ``modules``: A list of modules to be loaded before running a regression test on that partition (default ``[]``).

Expand Down Expand Up @@ -259,7 +259,7 @@ There exist also the following aliases for specific combinations of job schedule
Environments Configuration
--------------------------

The environments available for testing in different systems are defined under the ``environments`` key of the top-level ``_site_configuration`` dictionary.
The environments available for testing in different systems are defined under the ``environments`` key of the top-level ``site_configuration`` dictionary.
The ``environments`` key is associated to a special dictionary that defines scopes for looking up an environment. The ``*`` denotes the global scope and all environments defined there can be used by any system.
Instead of ``*``, you can define scopes for specific systems or specific partitions by using the name of the system or partition.
For example, an entry ``daint`` will define a scope for a system called ``daint``, whereas an entry ``daint:gpu`` will define a scope for a virtual partition named ``gpu`` on the system ``daint``.
Expand Down