Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding link to GFS #168

Merged
merged 5 commits into from
Mar 9, 2024
Merged

Adding link to GFS #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f9f6e3
add docs
Ai33L Mar 9, 2024
3c57f08
add docs
Ai33L Mar 9, 2024
48db6f6
add docs
Ai33L Mar 9, 2024
69c10d4
add docs
Ai33L Mar 9, 2024
4ae711d
try skip windows
Ai33L Mar 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/windows-package.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
push:
branches: [ master, without-dycore ]
pull_request:
branches: [ develop ]
branches: [ master ]

jobs:
windows_package:
Expand Down
9 changes: 9 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

9 changes: 0 additions & 9 deletions docs/components.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ Components
This page documents the different components available through climt.


Dynamics
---------

.. autosummary::
:toctree: generated/

GFSDynamicalCore
GFSDynamicalCore.__call__

Radiation
---------

Expand Down
12 changes: 12 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Loading