add docs

CliMT · Mar 9, 2024 · 48db6f6 · 48db6f6
1 parent 3c57f08
commit 48db6f6
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 15 deletions.
diff --git a/README.rst b/README.rst
@@ -63,6 +63,13 @@ https://sympl.readthedocs.io.
 Installation
 -------------
 
+Note - The GFS dynamical core has been made into a seperate package called 
+gfs_dynamical_core_ for ease of maintenance. If you need the dynamical core, 
+please install this package from source or directly using pip. Doing this will
+automatically install climt as well.
+
+    pip install gfs_dynamical_core
+
 climt can be installed directly from the python package index using pip.
 
     pip install climt
@@ -71,12 +78,6 @@ should work on most systems. From version 0.9.2 onwards, this command will
 install binary wheels, eliminating the requirement of a compiler on your
 system.
 
-Note - The GFS dynamical core has been made into a seperate package called 
-gfs_dynamical_core_ for ease of maintenance. If you need the dynamical core, 
-please install this package from source or directly using pip.
-
-    pip install gfs_dynamical_core
-
 Detailed instructions for Mac and Linux systems are available in the `documentation`_.
 
 Features

diff --git a/docs/components.rst b/docs/components.rst
@@ -8,15 +8,6 @@ Components
 This page documents the different components available through climt.
 
 
-Dynamics
----------
-
-.. autosummary::
-    :toctree: generated/
-
-    GFSDynamicalCore
-    GFSDynamicalCore.__call__
-
 Radiation
 ---------
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -7,6 +7,17 @@ Installation
 Stable release
 --------------
 
+.. NOTE::
+
+    The GFS dynamical core has been made into a seperate package called 
+    gfs_dynamical_core_ for ease of maintenance. If you need the dynamical core, 
+    please install this package from source or directly using pip. Doing this will
+    automatically install climt as well.
+
+    .. code-block:: console
+
+        $ install gfs_dynamical_core
+
 You can install climt by simply typing
 
 .. code-block:: console