diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 39e9680..9693ecf 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,3 +6,7 @@ repos: entry: python scripts/glossary_alphabetical.py language: system files: 'glossary.qmd' + - repo: https://github.com/citation-file-format/cff-converter-python + rev: ebf0b5e44d67f8beaa1cd13a0d0393ea04c6058d + hooks: + - id: validate-cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..6996013 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,28 @@ +cff-version: 1.2.0 +message: "If you use this guide, please cite it as below." +title: "Cloud Optimized Geospatial Formats Guide" +abstract: "Guide to methods for generating and testing Cloud-Optimized Geospatial Formats." +license: CC-BY-4.0 +repository: "https://github.com/cloudnativegeo/cloud-optimized-geospatial-formats-guide" +doi: "10.5281/zenodo.1003150" # TODO: Update +url: "https://guide.cloudnativegeo.org/" +authors: +- family-names: "Barciauskas" + given-names: "Aimee" + orcid: "https://orcid.org/0000-0002-3158-9554" +- family-names: "Mandel" + given-names: "Alex" + orcid: "https://orcid.org/0000-0003-2024-6801" +- family-names: "Pagán" + given-names: "Brianna" +- family-names: "Sarago" + given-names: "Vincent" +- family-names: "Holmes" + given-names: "Chris" +- family-names: "Quinn" + given-names: "Patrick" +- family-names: "Hanson" + given-names: "Matt" +- family-names: "Abernathey" + given-names: "Ryan" + orcid: "https://orcid.org/0000-0001-5999-4917" diff --git a/README.md b/README.md index cac0354..aa52338 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,15 @@ This site is built using [Quarto](https://quarto.org/docs/get-started/). To prev This project is licensed under the Creative Commons Attribution 4.0 International license. -Preferred citation: `Barciauskas, A et al. 2023. Cloud Optimized Geospatial Formats Guide. CC-By-4.0`. +## Citation + +Please cite the Cloud Optimized Geospatial Formats Guide through the project’s Zenodo archive using DOI: . This DOI represents all versions, and will always resolve to the latest one. + +The citation will look something like: + +> Aimee Barciauskas, TBA (2023). cloudnativegeo/cloud-optimized-geospatial-formats-guide: Cloud Optimized Geospatial Formats Guide v2025.05.21 (v2025.05.21). Zenodo. + +Please visit the Guide's [DOI link](TBA) to get the most recent version - the one above is not automatically generated and may be out of date as we release updated versions of the Guide. ## Questions? diff --git a/_quarto.yml b/_quarto.yml index c4f84bd..5c9a645 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -14,7 +14,7 @@ website: page-footer: right: "This page is built with ❤️ and [Quarto](https://quarto.org/)." center: 'Creative Commons Attribution 4.0 International License. ' - left: '© [Cloud-Native Geospatial Foundation](https://cloudnativegeo.org/), 2023' + left: '© [Cloud-Native Geospatial Forum](https://cloudnativegeo.org/), 2023' sidebar: pinned: true align: center diff --git a/_thankyous.qmd b/_thankyous.qmd index 2abf6a9..c2b1777 100644 --- a/_thankyous.qmd +++ b/_thankyous.qmd @@ -4,10 +4,10 @@ This guide has been made possible through the support of: -::: {layout="[15,-5,25,-3,20]" layout-valign="center"} +::: {layout="[15,-5,25,-3,15]" layout-valign="center"} [![](./images/thankyous-impact-logo.png){fig-alt="NASA Impact Logo" fig-align="left" width=40%}](https://impact.earthdata.nasa.gov) [![](./images/thankyous-devseed-logo.png){fig-alt="Development Seed Logo" fig-align="left" width=40%}](https://developmentseed.org) -[![](./images/thankyous-cng-logo.png){fig-alt="Cloud-Native Geospatial Foundation" fig-align="left" width=40%}](https://cloudnativegeo.org) +[![](./images/thankyous-cng-logo.png){fig-alt="Cloud-Native Geospatial Forum" fig-align="left" width=40%}](https://cloudnativegeo.org) ::: \ No newline at end of file diff --git a/contributing.qmd b/contributing.qmd index be5b4af..227eaeb 100644 --- a/contributing.qmd +++ b/contributing.qmd @@ -95,7 +95,15 @@ Once your PR is approved and all checks have passed, a project maintainer will m This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit [http://creativecommons.org/licenses/by/4.0/](http://creativecommons.org/licenses/by/4.0/). For attribution requirements, please look at the [license terms](http://creativecommons.org/licenses/by/4.0/). -Preferred citation: `Barciauskas, A et al. 2023. Cloud Optimized Geospatial Formats Guide. CC-By-4.0`. +## Citation + +Please cite the Cloud Optimized Geospatial Formats Guide through the project’s Zenodo archive using DOI: . This DOI represents all versions, and will always resolve to the latest one. + +The citation will look something like: + +> Aimee Barciauskas, TBA (2023). cloudnativegeo/cloud-optimized-geospatial-formats-guide: Cloud Optimized Geospatial Formats Guide v2025.05.21 (v2025.05.21). Zenodo. + +Please visit the Guide's [DOI link](TBA) to get the most recent version - the one above is not automatically generated and may be out of date as we release updated versions of the Guide. ## Contact diff --git a/images/thankyous-cng-logo.png b/images/thankyous-cng-logo.png index 55a440c..0e412c7 100644 Binary files a/images/thankyous-cng-logo.png and b/images/thankyous-cng-logo.png differ diff --git a/pmtiles/intro.qmd b/pmtiles/intro.qmd index 423f138..72f40a3 100644 --- a/pmtiles/intro.qmd +++ b/pmtiles/intro.qmd @@ -90,7 +90,7 @@ PMTiles has a [Python package](https://github.com/protomaps/PMTiles/tree/main/py ### MBTiles -The most common alternative for PMTiles is [MBTiles](https://github.com/mapbox/mbtiles-spec), which was in many ways the precursor to PMTiles. MBTiles stores the included vector tiles in a table in a SQLite database. MBTiles has the benefit of being much easier to use than manually managing millions of tiny, individual files, but MBTiles is not serverless. In general, it's impossible to read from a SQLite database without fetching the entire file's content. This means that frontend clients like a web browser couldn't fetch tiles directly using range requests, but rather a server has to be running to fetch tiles from the MBTiles file. +The most common alternative for PMTiles is [MBTiles](https://github.com/mapbox/mbtiles-spec), which was in many ways the precursor to PMTiles. MBTiles stores the included vector tiles in a table in a SQLite database. MBTiles has the benefit of being much easier to use than manually managing millions of tiny, individual files, but MBTiles is not serverless. In general, it's inefficient to read from a SQLite database without fetching the entire file's content. This means that frontend clients like a web browser couldn't fetch tiles directly using range requests, but rather a server has to be running to fetch tiles from the MBTiles file. ### Saving individual files to cloud storage