diff --git a/.github/workflows/windows-package.yml b/.github/workflows/windows-package.yml index d0d5d341..756cbb45 100644 --- a/.github/workflows/windows-package.yml +++ b/.github/workflows/windows-package.yml @@ -6,7 +6,7 @@ on: push: branches: [ master, without-dycore ] pull_request: - branches: [ develop ] + branches: [ master ] jobs: windows_package: diff --git a/README.rst b/README.rst index 4393fc66..7b14c3ab 100644 --- 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 @@ -102,3 +109,5 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack .. _Pint: https://pint.readthedocs.io .. _xarray: http://xarray.pydata.org .. _documentation: http://climt.readthedocs.io/en/latest/installation.html +.. _gfs_dynamical_core: https://github.com/Ai33L/gfs_dynamical_core + diff --git a/docs/components.rst b/docs/components.rst index 1a40ee18..4040143e 100644 --- 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 index a3d1a8fe..aae062f7 100644 --- 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 + + $ pip install gfs_dynamical_core + You can install climt by simply typing .. code-block:: console @@ -97,3 +108,4 @@ compile OpenMP programs, like the dynamical core in climt. .. _Github repo: https://github.com/climt/climt .. _tarball: https://github.com/CliMT/climt/tarball/master .. _anaconda: https://www.continuum.io/downloads +.. _gfs_dynamical_core: https://github.com/Ai33L/gfs_dynamical_core