frazane · sallen12 · Dec 24, 2024 · Dec 24, 2024 · Jan 16, 2025 · Jan 16, 2025
diff --git a/docs/crps_estimators.md → docs/background/crps_estimators.md b/docs/crps_estimators.md → docs/background/crps_estimators.md
diff --git a/docs/forecast_dists.md → docs/background/forecast_dists.md b/docs/forecast_dists.md → docs/background/forecast_dists.md
diff --git a/docs/theory.md → docs/background/theory.md b/docs/theory.md → docs/background/theory.md
diff --git a/docs/weighted_scores.md → docs/background/weighted_scores.md b/docs/weighted_scores.md → docs/background/weighted_scores.md
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/index.md b/docs/index.md
@@ -17,35 +17,34 @@ The scoring rules available in `scoringrules` include, but are not limited to, t
 - Logarithmic Score
 - (Discrete) Ranked Probability Score
 - Continuous Ranked Probability Score (CRPS)
-- Dawid-Sebastiani Score
 - Energy Score
 - Variogram Score
 - Gaussian Kernel Score
 - Threshold-Weighted CRPS
 - Threshold-Weighted Energy Score
 - Quantile Score
 - Interval Score
+- Weighted Interval Score
 
-
-
+Functionality is available for forecasts in the form of samples (i.e. ensemble forecasts) as well as popular univariate parametric distributions.
 
 ```{toctree}
 :hidden:
 :caption: Background
 
-theory.md
-forecast_dists.md
-crps_estimators.md
-weighted_scores.md
+background/theory.md
+background/forecast_dists.md
+background/crps_estimators.md
+background/weighted_scores.md
 ```
 
 ```{toctree}
 :hidden:
 :caption: Library
 
-user_guide.md
-contributing.md
-reference.md
+library/user_guide.md
+library/contributing.md
+library/reference.md
 ```
 
 

diff --git a/docs/library/contributing.md b/docs/library/contributing.md
@@ -0,0 +1,49 @@
+# Contributing
+
+We welcome contributions! You can help improve the library in many ways. For example, by:
+
+- Reporting issues or proposing enhancements via the [GitHub issue tracker](https://github.com/frazane/scoringrules/issues)
+- Improving or extending the codebase
+- Improving or extending the documentation
+
+## Getting started
+
+To make changes to the library, fork the repository on GitHub and clone it to your computer:
+
+```
+git clone https://github.com/<your-username>/scoringrules.git
+```
+
+We use [uv](https://docs.astral.sh/uv/) for project management and packaging. Install it by running
+
+```
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+You should then be able to install the library and all dependencies (including development dependencies), and install the pre-commit hooks:
+
+```
+uv install
+uv run pre-commit install
+```
+
+From here, you can work on your changes. Once you're satisfied with your changes, and have followed the additional instructions below, push everything to your repository and open a pull request on GitHub.
+
+
+### Contributing to the codebase
+
+Don't forget to include new tests if necessary. Make sure that all tests are passing with
+
+```
+uv run pytest tests/
+```
+
+### Contributing to the documentation
+
+You can work on the documentation by modifying files in `docs/`. The most convenient way to do this is to run
+
+```
+uvx --with-requirements docs/requirements.txt sphinx-autobuild docs/ docs/_build/
+```
+
+and open the locally hosted documentation on your browser. It will be updated automatically every time you make changes and save. If you edit or add pieces of LaTeX math, please make sure they are rendered correctly.
diff --git a/docs/library/generated/scoringrules.brier_score.rst b/docs/library/generated/scoringrules.brier_score.rst
@@ -0,0 +1,6 @@
+scoringrules.brier\_score
+=========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: brier_score
diff --git a/docs/library/generated/scoringrules.clogs_ensemble.rst b/docs/library/generated/scoringrules.clogs_ensemble.rst
@@ -0,0 +1,6 @@
+scoringrules.clogs\_ensemble
+============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: clogs_ensemble
diff --git a/docs/library/generated/scoringrules.crps_2pexponential.rst b/docs/library/generated/scoringrules.crps_2pexponential.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_2pexponential
+================================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_2pexponential
diff --git a/docs/library/generated/scoringrules.crps_2pnormal.rst b/docs/library/generated/scoringrules.crps_2pnormal.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_2pnormal
+===========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_2pnormal
diff --git a/docs/library/generated/scoringrules.crps_beta.rst b/docs/library/generated/scoringrules.crps_beta.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_beta
+=======================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_beta
diff --git a/docs/library/generated/scoringrules.crps_binomial.rst b/docs/library/generated/scoringrules.crps_binomial.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_binomial
+===========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_binomial
diff --git a/docs/library/generated/scoringrules.crps_clogistic.rst b/docs/library/generated/scoringrules.crps_clogistic.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_clogistic
+============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_clogistic
diff --git a/docs/library/generated/scoringrules.crps_cnormal.rst b/docs/library/generated/scoringrules.crps_cnormal.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_cnormal
+==========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_cnormal
diff --git a/docs/library/generated/scoringrules.crps_ct.rst b/docs/library/generated/scoringrules.crps_ct.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_ct
+=====================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_ct
diff --git a/docs/library/generated/scoringrules.crps_ensemble.rst b/docs/library/generated/scoringrules.crps_ensemble.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_ensemble
+===========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_ensemble
diff --git a/docs/library/generated/scoringrules.crps_exponential.rst b/docs/library/generated/scoringrules.crps_exponential.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_exponential
+==============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_exponential
diff --git a/docs/library/generated/scoringrules.crps_exponentialM.rst b/docs/library/generated/scoringrules.crps_exponentialM.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_exponentialM
+===============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_exponentialM
diff --git a/docs/library/generated/scoringrules.crps_gamma.rst b/docs/library/generated/scoringrules.crps_gamma.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_gamma
+========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_gamma
diff --git a/docs/library/generated/scoringrules.crps_gev.rst b/docs/library/generated/scoringrules.crps_gev.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_gev
+======================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_gev
diff --git a/docs/library/generated/scoringrules.crps_gpd.rst b/docs/library/generated/scoringrules.crps_gpd.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_gpd
+======================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_gpd
diff --git a/docs/library/generated/scoringrules.crps_gtclogistic.rst b/docs/library/generated/scoringrules.crps_gtclogistic.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_gtclogistic
+==============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_gtclogistic
diff --git a/docs/library/generated/scoringrules.crps_gtcnormal.rst b/docs/library/generated/scoringrules.crps_gtcnormal.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_gtcnormal
+============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_gtcnormal
diff --git a/docs/library/generated/scoringrules.crps_gtct.rst b/docs/library/generated/scoringrules.crps_gtct.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_gtct
+=======================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_gtct
diff --git a/docs/library/generated/scoringrules.crps_hypergeometric.rst b/docs/library/generated/scoringrules.crps_hypergeometric.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_hypergeometric
+=================================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_hypergeometric
diff --git a/docs/library/generated/scoringrules.crps_laplace.rst b/docs/library/generated/scoringrules.crps_laplace.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_laplace
+==========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_laplace
diff --git a/docs/library/generated/scoringrules.crps_logistic.rst b/docs/library/generated/scoringrules.crps_logistic.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_logistic
+===========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_logistic
diff --git a/docs/library/generated/scoringrules.crps_loglaplace.rst b/docs/library/generated/scoringrules.crps_loglaplace.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_loglaplace
+=============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_loglaplace
diff --git a/docs/library/generated/scoringrules.crps_loglogistic.rst b/docs/library/generated/scoringrules.crps_loglogistic.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_loglogistic
+==============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_loglogistic
diff --git a/docs/library/generated/scoringrules.crps_lognormal.rst b/docs/library/generated/scoringrules.crps_lognormal.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_lognormal
+============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_lognormal
diff --git a/docs/library/generated/scoringrules.crps_mixnorm.rst b/docs/library/generated/scoringrules.crps_mixnorm.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_mixnorm
+==========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_mixnorm
diff --git a/docs/library/generated/scoringrules.crps_negbinom.rst b/docs/library/generated/scoringrules.crps_negbinom.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_negbinom
+===========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_negbinom
diff --git a/docs/library/generated/scoringrules.crps_normal.rst b/docs/library/generated/scoringrules.crps_normal.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_normal
+=========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_normal
diff --git a/docs/library/generated/scoringrules.crps_poisson.rst b/docs/library/generated/scoringrules.crps_poisson.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_poisson
+==========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_poisson
diff --git a/docs/library/generated/scoringrules.crps_quantile.rst b/docs/library/generated/scoringrules.crps_quantile.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_quantile
+===========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_quantile
diff --git a/docs/library/generated/scoringrules.crps_t.rst b/docs/library/generated/scoringrules.crps_t.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_t
+====================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_t
diff --git a/docs/library/generated/scoringrules.crps_tlogistic.rst b/docs/library/generated/scoringrules.crps_tlogistic.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_tlogistic
+============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_tlogistic
diff --git a/docs/library/generated/scoringrules.crps_tnormal.rst b/docs/library/generated/scoringrules.crps_tnormal.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_tnormal
+==========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_tnormal
diff --git a/docs/library/generated/scoringrules.crps_tt.rst b/docs/library/generated/scoringrules.crps_tt.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_tt
+=====================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_tt
diff --git a/docs/library/generated/scoringrules.crps_uniform.rst b/docs/library/generated/scoringrules.crps_uniform.rst
@@ -0,0 +1,6 @@
+scoringrules.crps\_uniform
+==========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: crps_uniform
diff --git a/docs/library/generated/scoringrules.es_ensemble.rst b/docs/library/generated/scoringrules.es_ensemble.rst
@@ -0,0 +1,6 @@
+scoringrules.es\_ensemble
+=========================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: es_ensemble
diff --git a/docs/library/generated/scoringrules.gksmv_ensemble.rst b/docs/library/generated/scoringrules.gksmv_ensemble.rst
@@ -0,0 +1,6 @@
+scoringrules.gksmv\_ensemble
+============================
+
+.. currentmodule:: scoringrules
+
+.. autofunction:: gksmv_ensemble