Skip to content

291 add all regions and catalog queries to the documentation #292

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.

Sign up for GitHub

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

Merged
pabloitu merged 2 commits into from
Jan 29, 2026
Merged

291 add all regions and catalog queries to the documentation #292

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64ffadc
docs: updated regions in the API ref.
pabloitu Jan 28, 2026
ee9432a
docs: updated quadtree region in the API ref.
pabloitu Jan 28, 2026
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
14 changes: 14 additions & 0 deletions docs/reference/api_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,16 +207,30 @@ Region class(es):
:toctree: generated

CartesianGrid2D
CartesianGrid2D.from_origins
CartesianGrid2D.from_dict
CartesianGrid2D.to_dict
CartesianGrid2D.get_cartesian
CartesianGrid2D.get_cell_area
CartesianGrid2D.get_index_of

QuadtreeGrid2D
QuadtreeGrid2D.from_catalog
QuadtreeGrid2D.from_single_resolution
QuadtreeGrid2D.from_quadkeys
QuadtreeGrid2D.get_cartesian

Testing regions:

.. autosummary::
:toctree: generated

california_relm_region
california_relm_collection_region
italy_csep_region
italy_csep_collection_region
nz_csep_region
nz_csep_collection_region
global_region

Region utilities:
Expand Down