Skip to content

Commit

Permalink
[docs] Small revision for QuickStart
Browse files Browse the repository at this point in the history
  • Loading branch information
mjaehn committed Feb 17, 2023
1 parent 8a4b16c commit 91e4815
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions docs/QuickStart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ Quick Start


At CSCS (Daint, Tsa, Balfrin)
-----------------------------------------
-----------------------------

To set up a Spack instance, clone the repository

.. code-block:: console
Expand All @@ -25,7 +26,8 @@ You can force a machine with an argument. The name has to match a folder in sysc
Local machines and Containers
------------------------------
-----------------------------

Spack can autodetect compilers and preinstalled packages with

.. code-block:: console
Expand All @@ -38,6 +40,7 @@ Use packages
------------
To get information about a package, query Spack


.. code-block:: console
$ spack info <package>
Expand Down Expand Up @@ -76,17 +79,19 @@ To run it, you may need to load environment variables
$ spack load <variant>
ICON
-----
----

ICON is built using environments.
Environments sit in a folder with a name and are defined in a ``spack.yaml`` file.
For ICON they are located in ``config/cscs/spack-envs/<machine><target><compiler>``.
For ICON, they are located in ``config/cscs/spack-envs/<machine>_<target>_<compiler>``.

To activate the Spack environment, type

.. code-block:: console
$ spack env activate <path_to_folder_with_spack_yaml>
$ spack env activate -p -d <path_to_folder_with_spack_yaml>
To install the environment and so ICON, type

Expand All @@ -98,11 +103,13 @@ Example to build ICON for CPU with NVHPC:

.. code-block:: console
$ spack env activate config/cscs/spack-envs/daint_cpu_nvhpc
$ spack env activate -p -d config/cscs/spack-envs/daint_cpu_nvhpc
$ spack install
COSMO
-----

COSMO is currently receiving special treatment. It has its own commands in spack-c2sm.
The reason for this is that the optional depencendy on the C++ dycore lives in the same repository as COSMO.

Expand All @@ -127,9 +134,11 @@ Example variants:
$ spack installcosmo cosmo @org-master cosmo_target=gpu # GPU variant of https://github.com/COSMO-ORG/cosmo master
$ spack installcosmo cosmo @apn_5.09a.mch1.2.p1 cosmo_target=gpu # GPU variant of https://github.com/MeteoSwiss-APN/cosmo/releases/tag/5.09a.mch1.2.p1
Changelog to v0.17.1
---------------------
* Users manage their own instance instead of sourcing a preinstalled instance.
Changelog to v0.17.0
--------------------

* Users manage their own instance instead of sourcing a pr-einstalled instance.
* Users decide on their own when they would like to update their instance (i.e. after upgrades at CSCS).
* Due to new concretizer COSMO needs an explicit ``^mpich%nvhpc`` (Daint) or ``openmpi%nvhpc`` (Tsa) in spec, otherwise build fails.
* On Daint ICON is built using environments and ``dev-build`` is not supported anymore. On Balfrin ICON can still be built using ``dev-build``.
* Due to the new concretizer, COSMO needs an explicit ``^mpich%nvhpc`` (Daint) or ``openmpi%nvhpc`` (Tsa) in the spec, otherwise the build fails.
* On Daint, ICON is built using environments and ``dev-build`` no longer supported. On Balfrin, ICON can still be built using ``dev-build``.

0 comments on commit 91e4815

Please sign in to comment.