Commit 805c3fed authored by Isabelle Pison's avatar Isabelle Pison
Browse files

some typos corrected in the doc

parent 1717066b
......@@ -10,7 +10,7 @@ How to add a new type of flux data to be processed by the CIF into a model's inp
1. In directory :bash:`plugins/fluxes`, copy the directory containing the template for a flux plugin :bash:`flux_plugin_template` in the directory for your new plugin.
.. include:: register.rst
.. include:: ../newBCdata/register.rst
2. Modify the yaml file to use the new plugin: the minimum input arguments are :bash:`dir`, :bash:`file`, :bash:`varname` and :bash:`unit_conversion`. The default space and time interpolations will be applied (see XXXX doc sur premiere simu directe avec exmeple yaml quand mise a jourXXXXX).
......
......@@ -16,5 +16,6 @@ This documentation is valid for the version of LMDz-SACS that is embedded in the
timesteps
processes
verticalparam
.. outputs
ci
.. outputs
......@@ -8,7 +8,7 @@ Details on the different components of the CIF can be found below:
:maxdepth: 2
input-outputs/index
pandas
input-outputs/pandas
paths
plugins/index
doc-models/index
......@@ -188,7 +188,7 @@ From the information provided by the user, pyCIF deduces information which are u
Observations are often not snapshots. Instead, they overlap with several model time steps.
In pyCIF, time steps are computed as illustrated below:
.. graphviz:: time_steps.dot
.. graphviz:: ../time_steps.dot
:align: center
In the example, the transport model is run over two chained sub-periods of six time steps each.
......
......@@ -5,4 +5,4 @@
LMDz restart concentrations
##############################
.. automodule:: pycif.plugins.fields.lndz_icbc
.. automodule:: pycif.plugins.fields.lmdz_ic
......@@ -5,4 +5,4 @@
LMDz trajq files
#####################################
.. automodule:: pycif.plugins.fields.lmdz_trajq
.. automodule:: pycif.plugins.fields.lmdz_outfields_nc
......@@ -2,5 +2,5 @@
TM5
#####################
.. automodule:: pycif.plugins.models.tm5
.. automodule:: pycif.plugins.models.TM5
......@@ -2,4 +2,4 @@
Centre de Calcul CEA (TGCC) AMD
################################
.. automodule:: pycif.plugins.platforms.tgcc_amd
.. automodule:: pycif.plugins.platforms.ccrt_amd
......@@ -44,6 +44,12 @@ They must be pre-processed and provided in the format directly read by CHIMERE:
- the :doc:`METEO.nc files</documentation/doc-models/chimere/meteo>`
- the chemical scheme: see :doc:`the 12 files to define a chemical scheme </documentation/doc-models/chimere/chemistry>`
.. important::
**How to use the** :doc:`cheat-sheet</documentation/plugins/dependencies>` **for plugins**
In the following, plugins have te be used and provided specifications. The arguments can be found in the documentation of each plugin. To make access to the plugins easier, the cheat-sheet shows them sorted by **type**: the various types are the left-most (e.g. chemistre, controlvect, fields). For each type, available plugins are listed with the **name, version** of each displayed. Note that stating the name and version of a plugin is mandatory, whereas stating its type not always necessary.
3. Elaborate the yaml for the CIF:
====
......@@ -77,9 +83,7 @@ They must be pre-processed and provided in the format directly read by CHIMERE:
In this section of the yaml, it is possible to define :doc:`anchors</documentation/paths>` to be used in the rest of the file.
How to use the :doc:`cheat-sheet</documentation/plugins/dependencies>` for plugins
-----------------------------------------------------------------------------------
In the following, plugins have te be used and provided specifications. The arguments can be found in the documentation of each plugin. To make access to the plugins easier, the cheat-sheet shows them sorted by **type**: the various types are the left-most (e.g. chemistre, controlvect, fields). For each type, available plugins are listed with the **name, version** of each displayed. Note that stating the name and version of a plugin is mandatory, whereas stating its type not always necessary.
b. .. include:: mode.rst
......
......@@ -35,7 +35,7 @@ In case of a previous compilation, running the command below ensures that previo
2. Gather the input files
==========================
Some files must be pre-processed and provided in the format directly read by LMDz-SACS:
XXXXXXXXXXXX NE GARDER ICIQUE CEUX QUI NE SONT PAS GERES PAR UN PRE-PROC OU CEUX QUI SONT A L'ORIGINE DES FICHIERS D'ENTREE MAIS DOIVENT ETRE VRAIMENT TROUVES TOUT FAITS ex: les flux de masse XXXXXXXXXXXXXX
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment