From 3f19ee5a2bc09a48931f1a45c1dc9f72045c1ac3 Mon Sep 17 00:00:00 2001 From: Simon <31246246+SimonMolinsky@users.noreply.github.com> Date: Sun, 9 Nov 2025 11:09:01 +0200 Subject: [PATCH] CITATION.cff, citation section in readme has been moved up, bibtex citation has been added --- CHANGELOG.rst | 1 + CITATION.cff | 23 +++++++++++++++++++++++ README.md | 26 +++++++++++++++++++++----- docs/source/index.rst | 8 ++++---- 4 files changed, 49 insertions(+), 9 deletions(-) create mode 100644 CITATION.cff diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 83049806..5f82325b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -39,6 +39,7 @@ Changes - from version >= 1.x * [enhancement] `PointSupport` has the new parameters `values` and `geometries`, that might be provided instead of `ds` parameter * [docs] updated tutorials - new parameters are used in kriging operations, and when experimental variogram is computed * [docs] added missing badges (Python version and package version) +* [docs] `CITATION.cff`, citation section in readme has been moved up, bibtex citation has been added * # todo [docs] docstring examples - all user-facing API endpoints has examples in docstrings, using new input types (values | geometries) 2025-10-11 diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..a0e18ab4 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,23 @@ +cff-version: 1.2.0 +message: If you use this software, please cite both the article from preferred-citation and the software itself. +authors: + - family-names: Moliński + given-names: Szymon +title: 'Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets' +version: 1.0.0 +url: https://doi.org/10.21105/joss.02869 +doi: 10.21105/joss.02869 +date-released: '2022-11-09' +preferred-citation: + authors: + - family-names: Moliński + given-names: Szymon + title: 'Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets' + doi: 10.21105/joss.02869 + url: https://doi.org/10.21105/joss.02869 + type: article-journal + pages: '2869' + year: '2022' + conference: {} + publisher: + name: The Open Journal diff --git a/README.md b/README.md index f7bafda6..75d344ef 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,27 @@ The package was updated to version 1.0 in June 2025. There are breaking API changes, so please, refer to the [CHANGELOG](https://github.com/DataverseLabs/pyinterpolate/blob/main/CHANGELOG.rst) to know more about the changes. Right now, the package in version 1.0.0 is in the **beta** stage, which means that it is stable but be careful with the production use. There might be some minor bugs, and large swaths of code are not optimized yet. If you find any bugs, please report them in the [issue tracker](https://github.com/DataverseLabs/pyinterpolate/issues). +## Citation + +Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, https://doi.org/10.21105/joss.02869 + +### Bibtex + +```text +@article{Moliński2022, + doi = {10.21105/joss.02869}, + url = {https://doi.org/10.21105/joss.02869}, + year = {2022}, + publisher = {The Open Journal}, + volume = {7}, + number = {70}, + pages = {2869}, + author = {Moliński, Szymon}, + title = {Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets}, + journal = {Journal of Open Source Software} } + +``` + ## Introduction Pyinterpolate is the Python library for **spatial statistics**. The package provides access to spatial statistics tools (variogram analysis, Kriging, Poisson Kriging, Indicator Kriging, Inverse Distance Weighting). @@ -180,11 +201,6 @@ Pyinterpolate was created thanks to many resources and all of them are pointed h Join our community in Discord: [Discord Server Pyinterpolate](https://discord.gg/3EMuRkj) -## How to cite - -Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, https://doi.org/10.21105/joss.02869 - - ## Requirements and dependencies (v 1.x) Core requirements and dependencies are: diff --git a/docs/source/index.rst b/docs/source/index.rst index e734b015..7eb99e48 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,6 +22,10 @@ Important notice The package was updated to version 1.0 in June 2025. There are breaking API changes, so please, refer to the changelog, to know more about the changes. Right now, the package in version 1.0.0 is in the **beta** stage, which means that it is stable but be careful with the production use. There might be some minor bugs, and large swaths of code are not optimized yet. If you find any bugs, please report them in the `Github issue tracker `_. +Citation +-------- +Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, https://doi.org/10.21105/joss.02869 + Introduction ............ @@ -74,7 +78,3 @@ Contents api/api api/changes contributor/development - -Citation --------- -Moliński, S., (2022). Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets. Journal of Open Source Software, 7(70), 2869, https://doi.org/10.21105/joss.02869 \ No newline at end of file