From 4f9f6e39d571fa3a1206558f5fb3f958455ad66a Mon Sep 17 00:00:00 2001 From: Abel Shibu Date: Sat, 9 Mar 2024 17:17:13 +0530 Subject: [PATCH 1/5] add docs --- README.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.rst b/README.rst index 4393fc66..3b85f83f 100644 --- a/README.rst +++ b/README.rst @@ -71,6 +71,13 @@ 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 From 3c57f08255c4b76c85b47b3d5ee97720ee888244 Mon Sep 17 00:00:00 2001 From: Abel Shibu Date: Sat, 9 Mar 2024 17:19:02 +0530 Subject: [PATCH 2/5] add docs --- README.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 3b85f83f..370e3943 100644 --- a/README.rst +++ b/README.rst @@ -71,12 +71,11 @@ 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. +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 + pip install gfs_dynamical_core Detailed instructions for Mac and Linux systems are available in the `documentation`_. @@ -109,3 +108,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 + From 48db6f6a2da0241e5074b958cc03ffb499993b89 Mon Sep 17 00:00:00 2001 From: Abel Shibu Date: Sat, 9 Mar 2024 17:26:10 +0530 Subject: [PATCH 3/5] add docs --- README.rst | 13 +++++++------ docs/components.rst | 9 --------- docs/installation.rst | 11 +++++++++++ 3 files changed, 18 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 370e3943..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 @@ -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 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..2c0467b2 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 + + $ install gfs_dynamical_core + You can install climt by simply typing .. code-block:: console From 69c10d4d775de19ed0920c911c7afa913401500e Mon Sep 17 00:00:00 2001 From: Abel Shibu Date: Sat, 9 Mar 2024 17:33:31 +0530 Subject: [PATCH 4/5] add docs --- docs/installation.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index 2c0467b2..aae062f7 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -8,15 +8,15 @@ 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. + 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 +.. code-block:: console - $ install gfs_dynamical_core + $ pip install gfs_dynamical_core You can install climt by simply typing @@ -108,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 From 4ae711ded4e8a083d083195bfb49d9e49670bc56 Mon Sep 17 00:00:00 2001 From: Abel Shibu Date: Sat, 9 Mar 2024 17:38:52 +0530 Subject: [PATCH 5/5] try skip windows --- .github/workflows/windows-package.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/windows-package.yml b/.github/workflows/windows-package.yml index 37edcb05..7174b366 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: