Skip to content

Commit

Permalink
Merge branch 'main' into lee1043-patch-2
Browse files Browse the repository at this point in the history
  • Loading branch information
lee1043 authored Nov 13, 2024
2 parents 01f4eb1 + 29b3c88 commit 691c7ee
Show file tree
Hide file tree
Showing 31 changed files with 1,015 additions and 375 deletions.
1 change: 1 addition & 0 deletions conda-env/dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ dependencies:
- sphinx-book-theme
- sphinx-copybutton
- sphinx_rtd_theme
- furo
- nbsphinx
- pandoc
- sphinx-design
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/images/portrait_plot_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 34 additions & 11 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
API Reference
=============

APIs for Developers
-------------------
APIs
----

.. currentmodule:: pcmdi_metrics

Below is a list of APIs available in `pcmdi_metrics (> v3.6.1)` for developers.
Below is a list of Application Programming Interfaces (APIs) available in `pcmdi_metrics (> v3.6.1)`.


Custom calendars
~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

utils.custom_season_average
utils.custom_season_departure
utils.replace_date_pattern


Data load
~~~~~~~~~
Expand All @@ -16,6 +27,16 @@ Data load
io.xcdat_open


Date
~~~~
.. autosummary::
:toctree: generated/

utils.date_to_str
utils.extract_date_components
utils.find_overlapping_dates


Land-sea mask
~~~~~~~~~~~~~
.. autosummary::
Expand All @@ -26,29 +47,31 @@ Land-sea mask
utils.apply_oceanmask


Grid and regrid
~~~~~~~~~~~~~~~
Graphics
~~~~~~~~
.. autosummary::
:toctree: generated/

utils.create_target_grid
utils.regrid
graphics.parallel_coordinate_plot
graphics.portrait_plot
graphics.TaylorDiagram


Custom calendars
~~~~~~~~~~~~~~~~
Grid and regrid
~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

utils.custom_season_average
utils.custom_season_departure
utils.create_target_grid
utils.regrid


Region handling
~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

io.load_regions_specs
io.region_subset
io.region_from_file

Expand Down
40 changes: 25 additions & 15 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.

html_theme = "sphinx_book_theme"
# html_theme = "sphinx_rtd_theme"
# html_theme = "sphinx_book_theme"
html_theme = "furo"

# Theme options are theme-specific and customize the look and feel of a
# theme further. For a list of options available for each theme, see the
Expand All @@ -129,22 +131,30 @@
# https://sphinx-book-theme.readthedocs.io/en/latest/configure.html
html_logo = "_static/PMPLogo_500x421px_72dpi.png"
html_title = "PMP Documentation"
html_theme_options = {
"repository_url": "https://github.com/PCMDI/pcmdi_metrics",
"repository_branch": "main",
"path_to_docs": "docs",
"use_edit_page_button": True,
"use_repository_button": True,
"use_issues_button": True,
"use_download_button": True,
"use_fullscreen_button": True,

if html_theme == "sphinx_book_theme":
html_theme_options = {
"repository_url": "https://github.com/PCMDI/pcmdi_metrics",
"repository_branch": "main",
"path_to_docs": "docs",
"use_edit_page_button": True,
"use_repository_button": True,
"use_issues_button": True,
"use_download_button": True,
"use_fullscreen_button": True,
}

elif html_theme == "furo":
html_theme_options = {
"source_repository": "https://github.com/PCMDI/pcmdi_metrics",
"source_branch": "main",
"source_directory": "docs/",
}
elif html_theme == "sphinx_rtd_theme":
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

"""
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
"""

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ BSD 3-Clause License. See `LICENSE <https://github.com/PCMDI/pcmdi_metrics/blob/
:hidden:
:caption: For developers/contributors:

api
contributing
resources
team
Expand Down
12 changes: 8 additions & 4 deletions docs/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,17 @@ The notes below provide a brief summary of some of the key aspects of the PMP de
<iframe src="https://www.youtube.com/embed/STfCq5Biqf0" frameborder="0" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe>
</div>

References
----------
Lee, J., P. J. Gleckler, M.-S. Ahn, A. Ordonez, P. Ullrich, K. R. Sperber, K. E. Taylor, Y. Y. Planton, E. Guilyardi, P. Durack, C. Bonfils, M. D. Zelinka, L.-W. Chao, B. Dong, C. Doutriaux, C. Zhang, T. Vo, J. Boutte, M. F. Wehner, A. G. Pendergrass, D. Kim, Z. Xue, A. T. Wittenberg, and J. Krasting, 2024: Systematic and Objective Evaluation of Earth System Models: PCMDI Metrics Package (PMP) version 3. Geoscientific Model Development, 17, 3919–3948, https://doi.org/10.5194/gmd-17-3919-2024.

Gleckler et al. (2016), A more powerful reality test for climate models, Eos, 97, `doi:10.1029/2016EO051663 <https://eos.org/science-updates/a-more-powerful-reality-test-for-climate-models>`_.


Software framework and dependencies
-----------------------------------

Most of the PMP is based on `Python 3 <https://www.python.org/>`_ and built upon the Climate Data Analysis Tools (`CDAT <https://cdat.llnl.gov>`_).
The key component of CDAT used by the PMP is the Community Data Management System (`CDMS <https://cdms.readthedocs.io/en/latest/manual/cdms_1.html>`_) which provides access to a powerful collection of climate specific utilites, including cdutil, genutil and cdtime.
To modernize, PMP is in transition to implement Xarray Climate Data Analysis Tools (`xCDAT`_) as its primary building block.

Most of the PMP is based on `Python 3 <https://www.python.org/>`_ and built upon the `Xarray <https://docs.xarray.dev/en/stable/>`_ and the Xarray Climate Data Analysis Tools (`xCDAT`_).

Input/Output format
-------------------
Expand Down
1 change: 0 additions & 1 deletion docs/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@ Resources
.. toctree::
:maxdepth: 1

api
resources_legacy
Loading

0 comments on commit 691c7ee

Please sign in to comment.