How to cite pyrosm
==================

If you use **pyrosm** in academic research, reports, or other published work, please cite it.
Citing the software helps others find it and gives credit for the development effort.

Pyrosm is archived on `Zenodo <https://doi.org/10.5281/zenodo.3755057>`__, which provides a
permanent, citable DOI.

.. note::

   The DOI **10.5281/zenodo.3755057** always resolves to the *latest* version of pyrosm (the
   "all versions" concept DOI). The Zenodo record also mints a separate DOI for each individual
   release, so you can cite the exact version you used if you prefer.

Recommended citation
--------------------

   Tenkanen, H. (2026). *pyrosm: A Python library for reading and writing OpenStreetMap PBF data
   with GeoDataFrames*. (v0.10.0) Zenodo. https://doi.org/10.5281/zenodo.3755057

BibTeX
------

.. code-block:: bibtex

   @software{tenkanen_pyrosm,
     author    = {Tenkanen, Henrikki},
     title     = {{pyrosm: A Python library for reading and writing OpenStreetMap PBF data with GeoDataFrames}},
     year      = {2026},
     version   = {0.10.0},
     publisher = {Zenodo},
     doi       = {10.5281/zenodo.3755057},
     url       = {https://doi.org/10.5281/zenodo.3755057}
   }

Citing the data
---------------

When you publish results based on OpenStreetMap data read with pyrosm, please also acknowledge
the data sources: © `OpenStreetMap <https://www.openstreetmap.org/copyright>`__ contributors,
with extracts distributed by `Geofabrik <http://www.geofabrik.de/>`__ and
`BBBike <https://download.bbbike.org>`__.