Skip to content

Commit 55ceba8

Browse files
committed
docs: add grid module documentation and bibliography support
1 parent 1783de4 commit 55ceba8

5 files changed

Lines changed: 103 additions & 2 deletions

File tree

docs/source/api/grid.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _grid:
2+
3+
Grid Module
4+
==========
5+
6+
The grid module provides utilities for generating and manipulating spatial grids for climate data analysis.
7+
8+
Fekete Points
9+
------------
10+
11+
The ``FeketeGrid`` class implements algorithms for generating equidistant points on a sphere, based on the work by :cite:`strnad_climnet_2023`.
12+
13+
.. autoclass:: dominosee.grid.grid.FeketeGrid
14+
:members:
15+
:undoc-members:
16+
:show-inheritance:
17+

docs/source/api/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ Network construction
2121

2222
- :doc:`network`: Network creation and analysis utilities
2323

24+
Grid generation
25+
--------------
26+
27+
- :doc:`grid`: Grid generation and manipulation utilities
28+
2429
.. Utilities
2530
.. ---------
2631
@@ -34,4 +39,5 @@ Network construction
3439
eca
3540
es
3641
network
42+
grid
3743
.. utilities

docs/source/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
'sphinx_copybutton', # Add copy button to code blocks
3232
'jupyter_sphinx', # Execute code in the documentation
3333
'sphinx_autodoc_typehints', # Better handling of type hints in docstrings
34+
'sphinxcontrib.bibtex', # Bibliography support
35+
'sphinx_design', # Grid layouts and design elements
3436
]
3537

3638
# Add any paths that contain templates
@@ -102,6 +104,9 @@
102104
'dask': ('https://docs.dask.org/en/stable/', None),
103105
}
104106

107+
# Bibliography configuration
108+
bibtex_bibfiles = ['references.bib']
109+
105110
# Include documentation from both class docstring and __init__ docstring
106111
autoclass_content = 'both'
107112

docs/source/references.bib

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
@article{wang_spatially_2025,
2+
author = {Wang, Hui-Min and He, Xiaogang},
3+
title = {TBA},
4+
journal = {TBA},
5+
volume = {XX},
6+
number = {X},
7+
pages = {XXX--XXX},
8+
year = {2025},
9+
doi = {TBA}
10+
}
11+
12+
@article{bendito_estimation_2007,
13+
title = {Estimation of {Fekete} points},
14+
volume = {225},
15+
copyright = {https://www.elsevier.com/tdm/userlicense/1.0/},
16+
issn = {0021-9991},
17+
url = {https://linkinghub.elsevier.com/retrieve/pii/S0021999107001362},
18+
doi = {10.1016/j.jcp.2007.03.017},
19+
abstract = {We aim here at presenting a new procedure to numerically estimate the Fekete points of a wide variety of compact sets in R3. We understand the Fekete point problem in terms of the identification of near equilibrium configurations for a potential energy that depends on the relative position of N particles.},
20+
language = {en},
21+
number = {2},
22+
urldate = {2025-07-17},
23+
journal = {Journal of Computational Physics},
24+
author = {Bendito, E. and Carmona, A. and Encinas, A.M. and Gesto, J.M.},
25+
month = aug,
26+
year = {2007},
27+
note = {Publisher: Elsevier BV},
28+
pages = {2354--2376},
29+
}
30+
31+
32+
@software{strnad_climnet_2023,
33+
author = {Strnad, Felix and
34+
Schlör, Jakob},
35+
title = {climnet},
36+
month = aug,
37+
year = 2023,
38+
publisher = {Zenodo},
39+
version = {v2.2.0},
40+
doi = {10.5281/zenodo.8233634},
41+
url = {https://doi.org/10.5281/zenodo.8233634},
42+
}
43+
44+
@article{es_methods_placeholder,
45+
author = {Author, C.},
46+
title = {Event synchronization methods for climate networks},
47+
journal = {Climate Dynamics},
48+
volume = {XX},
49+
number = {X},
50+
pages = {XXX--XXX},
51+
year = {2025},
52+
doi = {placeholder}
53+
}
54+
55+
@article{siegmund_coincalcnew_2017,
56+
title = {{CoinCalc}—{A} new {R} package for quantifying simultaneities of event series},
57+
volume = {98},
58+
copyright = {https://www.elsevier.com/tdm/userlicense/1.0/},
59+
issn = {0098-3004},
60+
url = {https://linkinghub.elsevier.com/retrieve/pii/S0098300416305489},
61+
doi = {10.1016/j.cageo.2016.10.004},
62+
abstract = {We present the new R package CoinCalc for performing event coincidence analysis (ECA), a novel statistical method to quantify the simultaneity of events contained in two series of observations, either as simultaneous or lagged coincidences within a user-specific temporal tolerance window. The package also provides different analytical as well as surrogate-based significance tests (valid under different assumptions about the nature of the observed event series) as well as an intuitive visualization of the identified coincidences. We demonstrate the usage of CoinCalc based on two typical geoscientific example problems addressing the relationship between meteorological extremes and plant phenology as well as that between soil properties and land cover.},
63+
language = {en},
64+
urldate = {2025-07-09},
65+
journal = {Computers \& Geosciences},
66+
author = {Siegmund, Jonatan F. and Siegmund, Nicole and Donner, Reik V.},
67+
month = jan,
68+
year = {2017},
69+
note = {Publisher: Elsevier BV},
70+
pages = {64--72},
71+
}

pyproject.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,15 @@ dev = [
4545
"cartopy",
4646
]
4747
docs = [
48-
"sphinx>=4.0.0",
49-
"sphinx-rtd-theme>=1.0.0",
48+
"sphinx>=6.0.0",
49+
# "sphinx-rtd-theme>=1.0.0", # Not currently used, using Furo instead
5050
"furo>=2023.9.10",
5151
"nbsphinx>=0.8.0",
5252
"sphinx-copybutton>=0.5.0",
5353
"jupyter-sphinx>=0.3.2",
5454
"sphinx-autodoc-typehints>=1.15.0",
55+
"sphinx-design>=0.5.0",
56+
"sphinxcontrib-bibtex>=2.5.0",
5557
"matplotlib",
5658
"cartopy"
5759
]

0 commit comments

Comments
 (0)