Update bibliography and example (#84)

* Update bibliography and example * Fix typo
worldbank · Jul 17, 2024 · df868fc · df868fc
1 parent 082c693
commit df868fc
Show file tree

Hide file tree

Showing 4 changed files with 4,846 additions and 1,078 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,6 @@
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/worldbank/blackmarblepy/main.svg)](https://results.pre-commit.ci/latest/github/worldbank/blackmarblepy/main)
 [![downloads](https://static.pepy.tech/badge/blackmarblepy/month)](https://pepy.tech/project/blackmarblepy)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10667907.svg)](https://zenodo.org/doi/10.5281/zenodo.10667907)
-[![All Contributors](https://img.shields.io/github/all-contributors/worldbank/blackmarblepy)](#contributors)
 [![GitHub Repo stars](https://img.shields.io/github/stars/worldbank/blackmarblepy)](https://github.com/worldbank/blackmarblepy)
 
 **BlackMarblePy** is a Python package that provides a simple way to use nighttime lights data from NASA's Black Marble project. [Black Marble](https://blackmarble.gsfc.nasa.gov) is a [NASA Earth Science Data Systems (ESDS)](https://www.earthdata.nasa.gov) project that provides a product suite of daily, monthly and yearly global [nighttime lights](https://www.earthdata.nasa.gov/learn/backgrounders/nighttime-lights). This package automates the process of downloading all relevant tiles from the [NASA LAADS DAAC](https://www.earthdata.nasa.gov/eosdis/daacs/laads) to cover a region of interest, converting the raw files (in HDF5 format), to georeferenced rasters, and mosaicing rasters together when needed.
@@ -75,7 +74,7 @@ To build the documentation locally, after (1) and (2) above, please follow these
     pip install -e .[docs]
   ```
 
-- Build the documentation:m
+- Build the documentation:
 
   ```shell
     sphinx-build docs _build/html -b html
@@ -109,20 +108,36 @@ We welcome contributions to improve this documentation. If you find errors, have
 
 If you have any feedback, encounter issues, or want to suggest improvements, please [open an issue](https://github.com/worldbank/blackmarblepy/issues).
 
-## Contributors
+### Versioning
+
+[![CalVer](https://img.shields.io/badge/calver-YY.0M.MICRO-22bfda.svg)](https://calver.org)
+
+This project follows the [CALVER](https://calver.org) (Calendar Versioning) scheme for versioning. If you have any questions or need more information about our versioning approach, feel free to ask.
+
+### Contributors
+
+This project follows the [all-contributors](https://allcontributors.org) specification.
+Contributions of any kind are welcome!
+
+<a href="https://orcid.org/0000-0001-6530-3780">
+Gabriel Stefanini Vicente
+<img alt="ORCID logo" src="https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png" width="16" height="16" />
+</a>
+<br>
+<a href="https://orcid.org/0000-0002-3164-3813">
+Robert Marty
+<img alt="ORCID logo" src="https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png" width="16" height="16" />
+</a>
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
-
+m
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://allcontributors.org) specification.
-Contributions of any kind are welcome!
-
 ## Citation
 
 When using **BlackMarblePy**, your support is much appreciated! Please consider using the following citation or download [bibliography.bib](bibliography.bib):
@@ -132,7 +147,8 @@ When using **BlackMarblePy**, your support is much appreciated! Please consider
   title = {{BlackMarblePy: Georeferenced Rasters and Statistics of Nighttime Lights from NASA Black Marble}},
   author = {Gabriel {Stefanini Vicente} and Robert Marty},
   year = {2023},
-  note = {{BlackMarblePy} v0.2.3},
+  howpublished = {\url{https://worldbank.github.io/blackmarblepy}},
+  doi = {10.5281/zenodo.10667907},
   url = {https://worldbank.github.io/blackmarblepy},
 }
 ```

diff --git a/docs/bibliography.bib b/docs/bibliography.bib
@@ -2,7 +2,8 @@ @misc{blackmarblepy
   title = {{BlackMarblePy: Georeferenced Rasters and Statistics of Nighttime Lights from NASA Black Marble}},
   author = {Gabriel {Stefanini Vicente} and Robert Marty},
   year = {2023},
-  note = {{BlackMarblePy} v0.2.3},
+  howpublished = {\url{https://worldbank.github.io/blackmarblepy}},
+  doi = {10.5281/zenodo.10667907},
   url = {https://worldbank.github.io/blackmarblepy},
 }
 

diff --git a/notebooks/blackmarblepy.ipynb b/notebooks/blackmarblepy.ipynb
diff --git a/pyproject.toml b/pyproject.toml
@@ -71,5 +71,5 @@ skip = 'docs/_build,docs/references.bib,__pycache__,*.png,*.gz,*.whl'
 ignore-regex = '^\s*"image\/png":\s.*'
 ignore-words-list = "gost,"
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "numpy"