All plugins

aiida-icon

AiiDA Plugin to run simulations with the ICON weather & climate model

status beta AiiDA >=2.5

General information

Install pip install aiida-icon
Python import import aiida_icon
Latest version 0.5.0
Released 2025-08-26

Registry checks

All checks passed

Plugins provided

Calculations 1 Parsers 1

Entry points

CalcJobs and calculation functions aiida.calculations
  • icon.icon

    class: aiida_icon.calculations:IconCalculation

    AiiDA calculation to run ICON.

    InputRequiredValid typesDescription
    master_namelist true SinglefileData
    cloud_opt_props false RemoteData, NoneType
    code false AbstractCode, NoneType The `Code` to use for this job. This input is required, unless the `remote_folder` input is specified, which means an existing job is being imported and no code will actually be run.
    dmin_wetgrowth_lookup false RemoteData, NoneType
    dynamics_grid_file false RemoteData, NoneType
    ecrad_data false RemoteData, NoneType
    metadata false
    model_namelist false SinglefileData, NoneType
    models false SinglefileData, RemoteData
    monitors false Dict Add monitoring functions that can inspect output files while the job is running and decide to prematurely terminate the job.
    remote_folder false RemoteData, NoneType Remote directory containing the results of an already completed calculation job without AiiDA. The inputs should be passed to the `CalcJob` as normal but instead of launching the actual job, the engine will recreate the input files and then proceed straight to the retrieve step where the files of this `RemoteData` will be retrieved as if it had been actually launched through AiiDA. If a parser is defined in the inputs, the results are parsed and attached as output nodes as usual.
    restart_file false RemoteData, NoneType
    rrtmg_lw false RemoteData, NoneType
    rrtmg_sw false RemoteData, NoneType
    setup_env false SinglefileData, NoneType A file that is sourced before the execution of ICON and after environment variables passed through the 'metadata' input are set.
    wrapper_script false SinglefileData, NoneType
    OutputRequiredValid typesDescription
    all_restart_files true
    finish_status true
    latest_restart_file true
    remote_folder true RemoteData Input files necessary to run the process will be stored in this folder node.
    retrieved true FolderData Files that are retrieved by the daemon will be stored in this node. By default the stdout and stderr of the scheduler will be added, but one can add more by specifying them in `CalcInfo.retrieve_list`.
    output_streams false RemoteData Output streams of the ICON calculation
    remote_stash false RemoteStashData Contents of the `stash.source_list` option are stored in this remote folder after job completion.
    Exit statusMessage
    1 The process has failed with an unspecified error.
    2 The process failed with legacy failure mode.
    10 The process returned an invalid output.
    11 The process did not register a required output.
    100 The process did not have the required `retrieved` output.
    110 The job ran out of memory.
    120 The job ran out of walltime.
    131 The specified account is invalid.
    140 The node running the job failed.
    150 {message}
    300 ICON did not create a restart file or directory.
    301 Could not read the finish.status file.
    302 The final status was not 'OK or RESTART', check the finish_status output.
    303 Could not fully parse due to an unsupported feature, please check the log.
    304 Some outputs might be missing, check the log for explanations.
    310 ICON was expected to produce a restart file but did not.
CalcJob parsers aiida.parsers
  • icon.icon

    aiida_icon.calculations:IconParser