Skip to content

Commit

Permalink
Some minor corrections and additions
Browse files Browse the repository at this point in the history
  • Loading branch information
mjaehn committed Feb 5, 2024
1 parent aedf01d commit 34635d2
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# -- Project information ------------------------------------------------

project = 'Processing Chain'
copyright = '2018-2023, C2SM'
copyright = '2018-2024, C2SM'
author = 'Processing Chain Administrators'
version = 'v3.1'
release = 'v3.1'
Expand Down
14 changes: 12 additions & 2 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Jobs
* :func:`jobs.cosmo.main`
* :func:`jobs.emissions.main`
* :func:`jobs.icon.main`
* :func:`jobs.icontools.main`
* :func:`jobs.int2lm.main`
* :func:`jobs.obs_nudging.main`
* :func:`jobs.octe.main`
Expand All @@ -16,7 +17,8 @@ Jobs
* :func:`jobs.photo_rate.main`
* :func:`jobs.post_cosmo.main`
* :func:`jobs.post_int2lm.main`
* :func:`jobs.prepare_data.main`
* :func:`jobs.prepare_cosmo.main`
* :func:`jobs.prepare_icon.main`
* :func:`jobs.reduce_output.main`
* :func:`jobs.verify_chain.main`

Expand All @@ -42,6 +44,10 @@ Jobs

-------------------------------------------

.. autofunction:: jobs.icontools.main

-------------------------------------------

.. autofunction:: jobs.int2lm.main

-------------------------------------------
Expand Down Expand Up @@ -74,7 +80,11 @@ Jobs

-------------------------------------------

.. autofunction:: jobs.prepare_data.main
.. autofunction:: jobs.prepare_cosmo.main

-------------------------------------------

.. autofunction:: jobs.prepare_icon.main

-------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/jobs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ on ``icontools``, the order of execution is ``prepare_icon`` --> ``icontools``
--> ``prepare_art``. Note that if we had another job in there without dependencies,
it would run in parallel to the others.

Since the ``icon`` depends on all other jobs, it will be executed last. Note that
Since ``icon`` depends on all other jobs, it will be executed last. Note that
these dependencies are all listed under the ``current`` keyword, targeting
the current chunk. For ``icon``, there is an additional ``previous`` keyword.
This means that an ``icon`` simulation will always wait until the simulation
Expand Down

0 comments on commit 34635d2

Please sign in to comment.