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

Update FAQs, HPC guide, and Gentle Introduction #650

Merged
merged 16 commits into from
Jun 7, 2024
Merged

Conversation

tomvothecoder
Copy link
Collaborator

@tomvothecoder tomvothecoder commented Apr 30, 2024

Description

Summary of Changes

introduction-to-xcdat.ipynb

  • Updated overview section with conda env setup instructions similar to other notebooks
  • Re-ran outputs with latest version of xcdat=0.7.0 and xarray=2024.03.0
  • Replace add_bounds=True with add_bounds=["X", "Y", "T"]
  • Replace broken dataset filepath to esgf.nci.org.au to esgf-data1.llnl.gov
  • Add some descriptions to Dask parallelism section and run .compute()
  • TODO: Add link to xCDAT parallelism notebook from PR [PR]: Add Parallel Computing with Dask Jupyter Notebook #489

faqs.rst

  • Remove mention of striving to support common non-CF compliant metadata since I don't think we're actually doing that. The only non-CF compliant metadata xCDAT supports right now is decoding "months since ..." and "years since ...".
  • Add info about spatial averager supporting rectilinear grid
  • Add info about xCDAT's fall-back mapping table for axes
  • Update section on how bounds are generated with latest APIs
  • Replace "Data Wrangling" header to "xCDAT Does Not Support Model-Specific Data Wrangling"

getting-started-hpc-jupyter.rst

  • Add cartopy to conda command
  • Remove mentions of xesmf being an optional dependency and remove xesmf from conda command

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

If applicable:

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass with my changes (locally and CI/CD build)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

@github-actions github-actions bot added the type: docs Updates to documentation label Apr 30, 2024
@tomvothecoder tomvothecoder changed the title Update faqs.rst Update FAQs and HPC guide Apr 30, 2024
@tomvothecoder tomvothecoder changed the title Update FAQs and HPC guide Update FAQs, HPC guide, and Gentle Introduction Apr 30, 2024
@tomvothecoder tomvothecoder self-assigned this Apr 30, 2024
@tomvothecoder tomvothecoder marked this pull request as ready for review May 28, 2024 21:35
@tomvothecoder tomvothecoder added the good-first-issue Good first issue for new contributors label Jun 5, 2024
docs/getting-started-guide/faqs.rst Outdated Show resolved Hide resolved
docs/getting-started-guide/faqs.rst Outdated Show resolved Hide resolved
docs/getting-started-guide/faqs.rst Outdated Show resolved Hide resolved
Comment on lines -47 to -58
Note that ``xesmf`` is an optional dependency, which is required for using ``xesmf``
based horizontal regridding APIs in ``xcdat``. ``xesmf`` is not currently supported
on `osx-arm64`_ or `windows`_ because ``esmpy`` is not yet available on these
platforms. Windows users can try `WSL2`_ as a workaround.

.. _windows: https://github.com/conda-forge/esmf-feedstock/issues/64
.. _osx-arm64: https://github.com/conda-forge/esmf-feedstock/issues/74
.. _WSL2: https://docs.microsoft.com/en-us/windows/wsl/install

You may also want to use ``xcdat`` with some additional packages. For example, you can
install ``xcdat`` with ``matplotlib``, ``ipython``, and ``ipykernel`` (see the next
section for more about ``ipykernel``):
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI: xesmf is no longer an optional dependency

@tomvothecoder tomvothecoder merged commit e69693d into main Jun 7, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Good first issue for new contributors type: docs Updates to documentation
Projects
Status: Done
1 participant