Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
28 changes: 28 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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"
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <TBA>. 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. <TBA>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> Aimee Barciauskas, TBA (2023). cloudnativegeo/cloud-optimized-geospatial-formats-guide: Cloud Optimized Geospatial Formats Guide v2025.05.21 (v2025.05.21). Zenodo. <TBA>
>Aimee Barciauskas, Kyle Barron, Zac Deziel, Alex I. Mandel, Jed Sundwall, Julia Signell, Max Jones, Jonas, Leo Thomas, Jamison French, Tyler Erickson, Rajat Shinde, Kiri, Daniel Sparing, Blayne Chard, Brian Mc Donald, James Bourbeau, Luis López, autarc, & rsignell. (2025). Cloud Optimized Geospatial Formats Guide: https://doi.org/10.5281/zenodo.15498529

This is a slightly edited APA style citation.

Looks like Harvard and MLA are actually close to the current, it's fine to redirect people to the DOI zenodo page for other styles.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be clear I'm copying and pasting from the Citation generator on Zenodo with minor edits.


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a todo for later to see if we can use the Zenodo API to return the up to date citation, or quarto build hook.


## Questions?

Expand Down
2 changes: 1 addition & 1 deletion _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ website:
page-footer:
right: "This page is built with ❤️ and [Quarto](https://quarto.org/)."
center: '<a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>. <img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1"><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1">'
left: '&copy; [Cloud-Native Geospatial Foundation](https://cloudnativegeo.org/), 2023'
left: '&copy; [Cloud-Native Geospatial Forum](https://cloudnativegeo.org/), 2023'
sidebar:
pinned: true
align: center
Expand Down
4 changes: 2 additions & 2 deletions _thankyous.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)
:::
10 changes: 9 additions & 1 deletion contributing.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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: <TBA>. 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. <TBA>

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way we can avoid having to maintain this in 2 places?


## Contact

Expand Down
Binary file modified images/thankyous-cng-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pmtiles/intro.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down