Merging to stable

.github/workflows/python-package.yml

@@ -5,9 +5,9 @@ name: Python package
 
 on:
   push:
-    branches: [ master]
+    branches: [ stable]
   pull_request:
-    branches: [ master, develop ]
+    branches: [ stable, develop ]
 
 jobs:
   build:

AUTHORS.rst

@@ -3,16 +3,16 @@ Credits
 =======
 
 Original Creator
-----------------
+~~~~~~~~~~~~~~~~
 
 * Jeff Whitaker <jeffrey.s.whitaker@noaa.gov>
 
 Development Lead
-----------------
+~~~~~~~~~~~~~~~~
 
 * Abel Shibu <abels2000@gmail.com>
 
 Contributors
-------------
+~~~~~~~~~~~~
 
 * Joy Monteiro <joy.monteiro@misu.su.se>

HISTORY.rst

@@ -2,7 +2,13 @@
 History
 =======
 
-Latest
----------
+v0.1.23
+~~~~~~~
 
-* GFS Dynamical core moved from CLiMT to this repository.
+* Pypi build for 'GENERIC' architecture on Linux and MacOS.
+
+v0.1.9
+~~~~~~
+
+* GFS Dynamical core moved over from the CLiMT repository.
+* Pypi build released for Linux and MacOS.

README.rst

@@ -2,18 +2,27 @@
 gfs-dynamical-core
 ==================
 
-**gfs-dynamical-core** is home to the GFS dynamical core, which was previously available on
+**gfs-dynamical-core** is home to the GFS dynamical core, which was previously a part of
 CliMT_.
 
 Installation
 -------------
 
-gfs-dynamical-core can be installed directly from the python package index using pip.
+Python versions supported - 3.8, 3.9 and 3.10
+
+gfs-dynamical-core can be installed directly from the python package index using pip. This should
+also automatically install the correct version of climt.
 
     pip install gfs-dynamical-core
 
+Working versions - 0.1.23 and 0.1.9
+
+Specify the version if required
+
+    pip install gfs-dynamical-core==0.1.23
+
 This command should work on most systems and will install wheels for generic architecture. However,
-this may result in a slower code.
+this may result in a slightly slower code.
 
 To optimise the package for your system architecture, build it from source. See the documentation_
 for instructions.

docs/conf.py

@@ -119,7 +119,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+
+# html_theme = "sphinx_rtd_theme"
 
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'