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.

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

Add gentle introduction notebook #373

Merged
merged 17 commits into from
Nov 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 11 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. raw:: html

<p align="center">
<img src="./docs/_static/xcdat_logo.png" alt="xCDAT logo"/>
<img src="./docs/_static/xcdat-logo.png" alt="xCDAT logo"/>
</p>

.. container::
Expand All @@ -15,7 +15,7 @@
+--------------------+------------------------------------------------------+
| | Badges |
+====================+======================================================+
| Distribution | |conda| |conda-forge| |platforms| |conda-downloads| |
| Distribution | |conda-forge| |platforms| |conda-downloads| |
+--------------------+------------------------------------------------------+
| Citation | |zenodo-doi| |
+--------------------+------------------------------------------------------+
Expand All @@ -28,8 +28,6 @@

</h3>

.. |conda| image:: https://anaconda.org/conda-forge/xcdat/badges/installer/conda.svg
:target: https://anaconda.org/conda-forge/xcdat
.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/xcdat.svg
:target: https://anaconda.org/conda-forge/xcdat
.. |platforms| image:: https://img.shields.io/conda/pn/conda-forge/xcdat.svg
Expand All @@ -54,15 +52,14 @@
:target: http://mypy-lang.org/

xCDAT is an extension of `xarray`_ for climate data analysis on structured grids. It
serves as the spiritual successor to the Community Data Analysis Tools (`CDAT`_)
library.
serves as a modern successor to the Community Data Analysis Tools (`CDAT`_) library.

The goal of xCDAT is to provide generalizable climate domain features and utilities
that streamline the developer experience for data analysis code. xCDAT's design
philosophy is to reduce the complexity and overhead required by the user to accomplish
specific tasks in xarray. Some xCDAT features are inspired by or ported from core CDAT
functionalities, while others leverage powerful libraries in the xarray ecosystem
(e.g., `xESMF`_ and `cf_xarray`_) to deliver robust APIs.
The goal of xCDAT is to provide generalizable features and utilities for simple and
robust analysis of climate data. xCDAT's design philosophy is focused on reducing the
overhead required to accomplish certain tasks in xarray. Some key xCDAT features are
inspired by or ported from the core CDAT library, while others leverage powerful
libraries in the xarray ecosystem (e.g., `xESMF`_ and `cf_xarray`_) to deliver
robust APIs.

The xCDAT core team's mission is to provide a maintainable and extensible package
that serves the needs of the climate community in the long-term. We are excited
Expand Down Expand Up @@ -194,13 +191,14 @@ This software is jointly developed by scientists and developers from the Energy
Earth System Model (`E3SM`_) Project and Program for Climate Model Diagnosis and
Intercomparison (`PCMDI`_). The work is performed for the E3SM project, which is
sponsored by Earth System Model Development (`ESMD`_) program, and the Simplifying ESM
Analysis Through Standards (SEATS) project, which is sponsored by the Regional and
Analysis Through Standards (`SEATS`_) project, which is sponsored by the Regional and
Global Model Analysis (`RGMA`_) program. ESMD and RGMA are programs for the Earth and
Environmental Systems Sciences Division (`EESSD`_) in the Office of Biological and
Environmental Research (`BER`_) within the `Department of Energy`_'s `Office of Science`_.

.. _E3SM: https://e3sm.org/
.. _PCMDI: https://pcmdi.llnl.gov/
.. _SEATS: https://www.seatstandards.org/
.. _ESMD: https://climatemodeling.science.energy.gov/program/earth-system-model-development
.. _RGMA: https://climatemodeling.science.energy.gov/program/regional-global-model-analysis
.. _EESSD: https://science.osti.gov/ber/Research/eessd
Expand Down
Binary file added docs/_static/CF-xarray.png
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/CMIP6-logo.png
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/NumFocus-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/_static/dask-logo.svg
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/dataset-diagram.webp
Binary file not shown.
Binary file added docs/_static/e3sm-logo.jpg
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/e3sm-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_static/numpy-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/_static/pandas-logo.svg
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/pcmdi-logo.png
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/seats-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
#
# sphinx_book_theme configurations
# https://sphinx-book-theme.readthedocs.io/en/latest/configure.html
html_logo = "_static/xcdat_logo.png"
html_logo = "_static/xcdat-logo.png"
html_title = "xCDAT Documentation"
html_theme_options = {
"repository_url": "https://github.com/xCDAT/xcdat",
Expand Down
Loading