Skip to content
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
10 changes: 10 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ Connectivity
Grid.node_face_connectivity


.. _descriptors:

Descriptors
~~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -565,6 +567,8 @@ Azimuthal aggregations apply an aggregation (i.e. averaging) along circles of co
UxDataArray.azimuthal_mean


.. _zonal-average:

Zonal Average
~~~~~~~~~~~~~
.. autosummary::
Expand All @@ -586,6 +590,8 @@ Weighted
Spherical Geometry
------------------

.. _intersections:

Intersections
~~~~~~~~~~~~~

Expand All @@ -597,6 +603,8 @@ Intersections
grid.intersections.get_number_of_intersections


.. _arcs:

Arcs
~~~~

Expand All @@ -610,6 +618,8 @@ Arcs
grid.arcs.on_minor_arc


.. _compensated-arithmetic:

Compensated Arithmetic
----------------------

Expand Down
22 changes: 11 additions & 11 deletions docs/citations-for-algorithms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,54 +74,54 @@ Algorithm-to-Publication Mapping
* - Documentation section
- API or implementation
- Required citation(s)
* - `Descriptors <api.html#descriptors>`__
* - :ref:`Descriptors <descriptors>`
- :py:attr:`~uxarray.Grid.bounds`

:py:attr:`~uxarray.Grid.face_bounds_lon`

:py:attr:`~uxarray.Grid.face_bounds_lat`
- |cite-gmd|
* - `Zonal Average <api.html#zonal-average>`__
* - :ref:`Zonal Average <zonal-average>`
- All zonal-average remapping implementations (e.g. :py:meth:`~uxarray.UxDataArray.zonal_mean`)
- |cite-siam|
* - `Spherical Geometry: Intersections <api.html#intersections>`__
* - :ref:`Spherical Geometry: Intersections <intersections>`
- All spherical-intersection APIs in this section (:py:func:`~uxarray.grid.intersections.gca_gca_intersection`, :py:func:`~uxarray.grid.intersections.gca_const_lat_intersection`, :py:func:`~uxarray.grid.intersections.get_number_of_intersections`)
- **Cite both:**

|cite-gmd|

|cite-siam|
* - `Spherical Geometry: Arcs <api.html#arcs>`__
* - :ref:`Spherical Geometry: Arcs <arcs>`
- :py:func:`~uxarray.grid.arcs.in_between`

:py:func:`~uxarray.grid.arcs.point_within_gca`
- No new citation required. Expected to be removed in a future release.
* - `Spherical Geometry: Arcs <api.html#arcs>`__
* - :ref:`Spherical Geometry: Arcs <arcs>`
- :py:func:`~uxarray.grid.arcs.extreme_gca_latitude`
- |cite-gmd|
* - `Spherical Geometry: Arcs <api.html#arcs>`__
* - :ref:`Spherical Geometry: Arcs <arcs>`
- :py:func:`~uxarray.grid.arcs.orient3d_on_sphere`

:py:func:`~uxarray.grid.arcs.on_minor_arc`
- |cite-shewchuk|
* - `Compensated Arithmetic <api.html#compensated-arithmetic>`__
* - :ref:`Compensated Arithmetic <compensated-arithmetic>`
- :py:func:`~uxarray.utils.computing.two_sum`
- |cite-knuth|
* - `Compensated Arithmetic <api.html#compensated-arithmetic>`__
* - :ref:`Compensated Arithmetic <compensated-arithmetic>`
- :py:func:`~uxarray.utils.computing.two_prod`
- |cite-dekker|
* - `Compensated Arithmetic <api.html#compensated-arithmetic>`__
* - :ref:`Compensated Arithmetic <compensated-arithmetic>`
- :py:func:`~uxarray.utils.computing.diff_of_products`
- **Cite both:**

|cite-higham|

|cite-jeannerod|
* - `Compensated Arithmetic <api.html#compensated-arithmetic>`__
* - :ref:`Compensated Arithmetic <compensated-arithmetic>`
- :py:func:`~uxarray.utils.computing.accucross`

:py:func:`~uxarray.utils.computing.accucross_pair`
- |cite-gmd|
* - `Compensated Arithmetic <api.html#compensated-arithmetic>`__
* - :ref:`Compensated Arithmetic <compensated-arithmetic>`
- :py:func:`~uxarray.utils.computing.acc_sqrt_re`
- |cite-rump|
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,8 @@ def __getattr__(cls, name):
r"https://healpix.sourceforge.io/*",
r"https://zenodo.org/*",
r"https://doi.org/10.5281/zenodo*",
r"https://stackoverflow.com/*", # Cloudflare bot protection
r"https://doi.org/10.1137/*", # SIAM DOIs -> epubs.siam.org blocks bots
# More URLs as needed
]

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ homepage <https://git-scm.com/>`_).
Git has lots and lots of commands, each with lots and lots of options. Even if we
can cover some of them throughout this guide, your best friend for figuring out
to do things with Git may be Google, and in particular
`StackOverflow <https://stackoverflow.com/>`_.
`StackOverflow <https://stackoverflow.com/questions>`_.

Configure your environment to authenticate with GitHub from Git. This is a
complicated process, so we suggest that you refer to the details in the
Expand Down