Commit 435654cc authored by Loic Huder's avatar Loic Huder
Browse files

Minor changes in doc files

parent c608731d
......@@ -33,7 +33,7 @@ with open(os.path.join(os.path.dirname(__file__), "../pygeodyn/_version.py")) as
assert __version__ is not None
# The full version, including alpha/beta/rc tags
release = __version__
# The short X.Y version (keep semantic versionning)
# The short X.Y version (keep semantic versioning)
version = release
# -- General configuration ---------------------------------------------------
......
......@@ -44,6 +44,13 @@ instead. The absence of the ``--recursive`` option will prevent the cloning of t
Note however that you will not be able to run the `run_algo <https://geodynamo.gricad-pages.univ-grenoble-alpes.fr/pygeodyn/usage_run_algo.html>`_ script unless you supply your own dataset (procedure described at https://geodynamo.gricad-pages.univ-grenoble-alpes.fr/pygeodyn/usage_new_types.html).
It is still possible to download the `pygeodyn_data`_ submodule afterwards by running
.. code-block:: bash
cd pygeodyn
git submodule update --init
.. _pygeodyn: https://gricad-gitlab.univ-grenoble-alpes.fr/Geodynamo/pygeodyn
.. _pygeodyn_data: https://gricad-gitlab.univ-grenoble-alpes.fr/Geodynamo/pygeodyn_data
......@@ -69,7 +76,7 @@ Note however that with this installation, any change to the source code will not
Develop installation
--------------------
If you intend to change the source code of pygeodyn (by defining new types), it is easier to install it with ``develop``:
If you intend to change the source code of pygeodyn (e.g. by defining new types), it is easier to install it with ``develop``:
.. code-block:: bash
......
......@@ -30,7 +30,7 @@ Usage
and accepts the following arguments:
* Scientific parameters
* Computation parameters
* ``-conf``: Path to the `configuration file`_ (no default value: must be given)
* ``-algo``: the name of the `algorithm`_ to use (default: ``augkf``).
* ``-m``: the number of `realisations`_ to consider (default: 20)
......
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