Getting Started - Revision history

Editor 2: /* Getting the source code */ removed the git init submodules since it is no longer needed ~LR

2024-11-22T08:10:18Z

Getting the source code: removed the git init submodules since it is no longer needed ~LR

← Older revision		Revision as of 10:10, 22 November 2024
Line 17:		Line 17:
	The source code for ART is available in the open-source ICON repository under [http://www.icon-model.org www.icon-model.org]		The source code for ART is available in the open-source ICON repository under [http://www.icon-model.org www.icon-model.org]

	To clone the ICON repository use :		To clone the ICON repository use:

	<code>		<code>
Line 23:		Line 23:
	</code>		</code>

	This will get the ICON ~~reository.~~ To ~~get~~ the ~~all~~ submodules (including ART):		This will get the ICON repository and additionally, because of the --recursive flag, also the submodules (including ART).

	<code>
	git submodule update --init
	</code>

	== Installation ==		== Installation ==

Editor 2: /* The auto-icon tool for automating runs */

2024-10-09T13:13:23Z

The auto-icon tool for automating runs

← Older revision		Revision as of 15:13, 9 October 2024
Line 4:		Line 4:

	== The auto-icon tool for automating runs ==		== The auto-icon tool for automating runs ==
	auto-icon is a flexible tool for automating ICON(-ART) runs, starting from the retrieval of input data to post-processing and visualization. After an initial set-up, a great simplification in running various examples can be achieved. auto-icon takes care of obtaining the model code and installing it on the desired HPC system, retrieving parts of the input data (more to come) and running the model. Custom post-processing and visualization tasks can be added to the pipeline to get them executed automatically. The automation engine behind auto-icon, called [https://autosubmit.readthedocs.io/en/master/ Autosubmit], is a powerful and flexible tool, providing multi-platform support, fault tolerance and an experiment database. The latter stores metadata for all conducted experiments and allows simple finding and reproduction of existing workflows, thus promoting the [http://www.go-fair.org/fair-principles/ FAIR] principles.		''auto-icon'' is a flexible tool for automating ICON(-ART) runs, starting from the retrieval of input data to post-processing and visualization. After an initial set-up, a great simplification in running various examples can be achieved. ''auto-icon'' takes care of obtaining the model code and installing it on the desired HPC system, retrieving parts of the input data (more to come) and running the model. Custom post-processing and visualization tasks can be added to the pipeline to get them executed automatically. The automation engine behind ''auto-icon'', called [https://autosubmit.readthedocs.io/en/master/ Autosubmit], is a powerful and flexible tool, providing multi-platform support, fault tolerance and an experiment database. The latter stores metadata for all conducted experiments and allows simple finding and reproduction of existing workflows, thus promoting the [http://www.go-fair.org/fair-principles/ FAIR] principles.

	~~The~~ ~~configurations~~ ~~for~~ the ICON-ART ~~standard~~ ~~cases~~ ~~(see~~ ~~below~~ and [https://www.icon-art.kit.edu/~~userguide/index.php?title=Tutorial_Examples~~ ~~Tutorial~~ ~~examples~~]) are included as templates along with a few other cases~~. These run out of the box in just a few steps~~. There is a separate [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/home Wiki] for auto-icon with a [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Shortest-guide-to-success shortest guide to success] and a [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Usage/Step-by-step-guide more detailed guide].		Especially if you are new to the ICON-ART model, ''auto-icon'' can help you set up a first run as it builds the model for you and has a bunch of example cases built in, running out of the box. These [https://www.icon-art.kit.edu/ ICON-ART standard cases] are included as templates along with a few other cases. There is a separate [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/home Wiki] for ''auto-icon'' with a [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Shortest-guide-to-success shortest guide to success] and a [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Usage/Step-by-step-guide more detailed guide].

	The remainder of this Wiki serves as valuable source of information on how ART works, while the auto-icon Wiki only deals with technical aspects of auto-icon.		The remainder of this Wiki serves as valuable source of information on how the ART module itself works, while the ''auto-icon'' Wiki only deals with technical aspects of ''auto-icon''.
	Further, auto-icon does not use runscripts to conduct the runs but instead loads a configuration and a namelist describing the whole model workflow. The correspondence of runscript entries with the configuration is demonstrated in [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Usage/Transform-a-runscript-into-an-auto-icon-configuration this guide].		Further, ''auto-icon'' does not use runscripts to conduct the runs but instead loads a configuration and a namelist describing the whole model workflow. The correspondence of runscript entries with the configuration is demonstrated in [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Usage/Transform-a-runscript-into-an-auto-icon-configuration this guide].

	~~You~~ ~~can~~ ~~choose~~ ~~between~~ ~~using~~ auto-icon ~~for~~ ~~your~~ ~~runs~~ or ~~the runscript approach. For the former, consult~~ the linked ~~pages,~~ ~~for~~ ~~the latter go on with~~ the remainder of this page ~~to get started~~.		For starting your ICON model run with ''auto-icon'', you go to one of the linked guides and skip the remainder of this page.

	== Getting the source code ==		== Getting the source code ==

Editor 2 at 11:00, 17 June 2024

2024-06-17T11:00:57Z

← Older revision		Revision as of 13:00, 17 June 2024
Line 2:		Line 2:

	As for most atmospheric models, it is strongly recommended to run ICON-ART on a High Performance Computing system such as Levante from the [https://www.dkrz.de/en DKRZ] or [https://www.scc.kit.edu/en/services/horeka.php HoreKA] from KIT. This usually requires an account which has to be obtained through the respective HPC Systems procedures.		As for most atmospheric models, it is strongly recommended to run ICON-ART on a High Performance Computing system such as Levante from the [https://www.dkrz.de/en DKRZ] or [https://www.scc.kit.edu/en/services/horeka.php HoreKA] from KIT. This usually requires an account which has to be obtained through the respective HPC Systems procedures.

			== The auto-icon tool for automating runs ==
			auto-icon is a flexible tool for automating ICON(-ART) runs, starting from the retrieval of input data to post-processing and visualization. After an initial set-up, a great simplification in running various examples can be achieved. auto-icon takes care of obtaining the model code and installing it on the desired HPC system, retrieving parts of the input data (more to come) and running the model. Custom post-processing and visualization tasks can be added to the pipeline to get them executed automatically. The automation engine behind auto-icon, called [https://autosubmit.readthedocs.io/en/master/ Autosubmit], is a powerful and flexible tool, providing multi-platform support, fault tolerance and an experiment database. The latter stores metadata for all conducted experiments and allows simple finding and reproduction of existing workflows, thus promoting the [http://www.go-fair.org/fair-principles/ FAIR] principles.

			The configurations for the ICON-ART standard cases (see below and [https://www.icon-art.kit.edu/userguide/index.php?title=Tutorial_Examples Tutorial examples]) are included as templates along with a few other cases. These run out of the box in just a few steps. There is a separate [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/home Wiki] for auto-icon with a [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Shortest-guide-to-success shortest guide to success] and a [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Usage/Step-by-step-guide more detailed guide].

			The remainder of this Wiki serves as valuable source of information on how ART works, while the auto-icon Wiki only deals with technical aspects of auto-icon.
			Further, auto-icon does not use runscripts to conduct the runs but instead loads a configuration and a namelist describing the whole model workflow. The correspondence of runscript entries with the configuration is demonstrated in [https://gitlab.dkrz.de/auto-icon/auto-icon/-/wikis/Usage/Transform-a-runscript-into-an-auto-icon-configuration this guide].

			You can choose between using auto-icon for your runs or the runscript approach. For the former, consult the linked pages, for the latter go on with the remainder of this page to get started.

	== Getting the source code ==		== Getting the source code ==

Admin 1: /* Installation */ added hint to GPL conditions

2024-04-12T12:08:37Z

Installation: added hint to GPL conditions

← Older revision		Revision as of 14:08, 12 April 2024
Line 22:		Line 22:

	ICON-ART is already included in the most recent ICON version. For Instructions on how to install ICON, please refer to the first chapter of the [https://www.dwd.de/DE/leistungen/nwv_icon_tutorial/nwv_icon_tutorial.html:official ICON Model Tutorial].		ICON-ART is already included in the most recent ICON version. For Instructions on how to install ICON, please refer to the first chapter of the [https://www.dwd.de/DE/leistungen/nwv_icon_tutorial/nwv_icon_tutorial.html:official ICON Model Tutorial].
	The only caveat is that during the configuration step the tag <code> --enable-art </code> has to be included. In addition, to set-up and use chemical mechanisms using the MECCA/KPP the related interfaces ~~has~~ to be included using the tag <code> --enable-art —enable-art-gpl </code>.		The only caveat is that during the configuration step the tag <code> --enable-art </code> has to be included. In addition, to set up and use chemical mechanisms using the MECCA/KPP the related interfaces have to be included using the tag <code> --enable-art —enable-art-gpl </code> (Be aware that you accept the GPL conditions for MECCA and KPP when you use this option).

	<b>General step-by-step guide:</b>		<b>General step-by-step guide:</b>

Admin 1: /* Installation */

2024-03-25T09:48:13Z

Installation

← Older revision		Revision as of 11:48, 25 March 2024
Line 33:		Line 33:
	<b>Example for HoreKa at KIT:</b>		<b>Example for HoreKa at KIT:</b>
	# Access your ICON main folder.		# Access your ICON main folder.
	# Run the following command: <code>config/kit/hk.intel-2022-openmpi-4.0 --enable-art</code>		# Run the following command: <code>config/kit/hk.intel-2022-openmpi-4.0 --enable-art --enable-ecrad</code>
	# Execute <code>make -j4</code>		# Execute <code>make -j4</code>
	# You should now have a functional binary with ART integration. For other HPC systems, substitute the config script with the one relevant to your HPC system.		# You should now have a functional binary with ART integration. For other HPC systems, substitute the config script with the one relevant to your HPC system.

Admin 1: /* Installation */

2024-02-14T17:06:06Z

Installation

← Older revision		Revision as of 19:06, 14 February 2024
Line 22:		Line 22:

	ICON-ART is already included in the most recent ICON version. For Instructions on how to install ICON, please refer to the first chapter of the [https://www.dwd.de/DE/leistungen/nwv_icon_tutorial/nwv_icon_tutorial.html:official ICON Model Tutorial].		ICON-ART is already included in the most recent ICON version. For Instructions on how to install ICON, please refer to the first chapter of the [https://www.dwd.de/DE/leistungen/nwv_icon_tutorial/nwv_icon_tutorial.html:official ICON Model Tutorial].
	The only caveat is that during the configuration step the tag <code> --enable-art </code> has to be included.		The only caveat is that during the configuration step the tag <code> --enable-art </code> has to be included. In addition, to set-up and use chemical mechanisms using the MECCA/KPP the related interfaces has to be included using the tag <code> --enable-art —enable-art-gpl </code>.

	<b>General step-by-step guide:</b>		<b>General step-by-step guide:</b>

Admin 1: /* Getting the source code */

2024-02-06T09:32:16Z

Getting the source code

← Older revision		Revision as of 11:32, 6 February 2024
Line 14:		Line 14:

	This will get the ICON reository. To get the all submodules (including ART):		This will get the ICON reository. To get the all submodules (including ART):

	<code>		<code>
	git submodule update --init		git submodule update --init

Admin 1: /* Getting the source code */

2024-02-06T09:30:36Z

Getting the source code

← Older revision		Revision as of 11:30, 6 February 2024
Line 7:		Line 7:
	The source code for ART is available in the open-source ICON repository under [http://www.icon-model.org www.icon-model.org]		The source code for ART is available in the open-source ICON repository under [http://www.icon-model.org www.icon-model.org]

	To clone the ICON repository ~~including all submodules (including ART)~~ use :		To clone the ICON repository use :

	<code>		<code>
	git clone --recursive https://gitlab.dkrz.de/icon/icon-model.git		git clone --recursive https://gitlab.dkrz.de/icon/icon-model.git
	</code>		</code>

			This will get the ICON reository. To get the all submodules (including ART):
	<code>		<code>
	git submodule update --init		git submodule update --init

Admin 1: /* Getting the source code */

2024-02-06T09:29:15Z

Getting the source code

← Older revision		Revision as of 11:29, 6 February 2024
Line 11:		Line 11:
	<code>		<code>
	git clone --recursive https://gitlab.dkrz.de/icon/icon-model.git		git clone --recursive https://gitlab.dkrz.de/icon/icon-model.git
			</code>
			<code>
	git submodule update --init		git submodule update --init
	</code>		</code>

Admin 1: /* Getting the source code */

2024-02-06T09:28:13Z

Getting the source code

← Older revision		Revision as of 11:28, 6 February 2024
Line 5:		Line 5:
	== Getting the source code ==		== Getting the source code ==

			The source code for ART is available in the open-source ICON repository under [http://www.icon-model.org www.icon-model.org]

		⚫	To clone the ICON repository including all submodules (including ART) use :
	A user who wants to work with ICON-ART has to sign the ICON license agreement with the German Weatherservice (DWD) and Max-Planck-Institute for Meteorology (MPI-M) first. Further information can be found on the following website:

	https://code.mpimet.mpg.de/projects/iconpublic

	Afterwards you also should get access to the DKRZ gitlab. If you have access you can clone ICON.

⚫	~~Example~~ ~~for cloning~~ the ICON~~-KIT~~ repository including all submodules (including ART):

	<code>		<code>
	git clone --recursive ~~git@~~gitlab.dkrz.de:icon/icon-~~kit~~.git		git clone --recursive https://gitlab.dkrz.de/icon/icon-model.git
			git submodule update --init
	</code>		</code>