Skip to content

Latest commit

 

History

History
91 lines (64 loc) · 2.11 KB

contributing.rst

File metadata and controls

91 lines (64 loc) · 2.11 KB
.. currentmodule:: cf_xarray


.. ipython:: python
    :suppress:

    import cf_xarray.accessor

Contributing

This section will be expanded later. For now it tells you how to get setup to run the tests and lists docstrings for a number of internal variables, classes and functions.

Running the tests

The simplest way is using conda/mamba (same as in the CI). Create yourself a conda/mamba environment (e.g. mamba create -f ci/environment.yml). Activate your environment. Next install the local version of cf-xarray, python -m pip install --no-deps -e .. Now you are ready to run the tests with pytest.

Pre-commit

If you want the pre-commit hook too, after installing your environment as above, simply install pre-commit (pip install pre-commit) and then run pre-commit install. Now each time you commit you'll get the pre-commit checks for free.

Variables

.. autodata:: cf_xarray.accessor._AXIS_NAMES

.. autodata:: cf_xarray.accessor._CELL_MEASURES

.. autodata:: cf_xarray.accessor._COORD_NAMES

.. autodata:: cf_xarray.accessor._WRAPPED_CLASSES

Attribute parsing

This dictionary contains criteria for identifying axis and coords using CF attributes. It was copied from MetPy

.. autosummary::
   :toctree: generated/

   ~accessor.coordinate_criteria

Classes

.. autosummary::
   :toctree: generated/
   :template: autosummary/accessor_class.rst


    ~accessor.CFAccessor
    ~accessor._CFWrappedClass
    ~accessor._CFWrappedPlotMethods

Functions

Primarily for developer reference. Some of these could become public API if necessary.

.. autosummary::
   :toctree: generated/

    ~accessor._getattr
    ~accessor._getitem
    ~accessor._get_all
    ~accessor._get_axis_coord
    ~accessor._get_bounds
    ~accessor._get_coords
    ~accessor._get_custom_criteria
    ~accessor._get_dims
    ~accessor._get_groupby_time_accessor
    ~accessor._get_indexes
    ~accessor._get_measure
    ~accessor._get_with_standard_name