Add scientific data and geospatial publishing guides & case study#2243
Add scientific data and geospatial publishing guides & case study#2243
Conversation
🚀 Build Preview on IPFS ready
|
|
This is great as a specific how-to. Is there another, complementary place we can write about all the ways geospatial users can benefit from IPFS? From live meeting:
|
Co-authored-by: Volker Mische <volker.mische@gmail.com>
Co-authored-by: Mosh <1306020+mishmosh@users.noreply.github.com>
Co-authored-by: Mosh <1306020+mishmosh@users.noreply.github.com>
|
|
||
| Users can then access your data by using the `ipns://` prefix. | ||
|
|
||
| TODO: add example. |
| --raw-leaves \ | ||
| --chunker=size-1048576 \ | ||
| --cid-version=1 \ |
There was a problem hiding this comment.
Once Kubo 0.40 ships these could be removed and replaced by one-time ipfs config profile apply unixfs-v1-2025 or setting Import.* values one-by-one
|
|
||
| In this guide, you'll find an overview of the problem space, available tools, and architectural patterns for publishing and working with scientific data using IPFS. | ||
|
|
||
| ## A Landscape in Flux |
There was a problem hiding this comment.
From Slack:
Condense “A Landscape in Flux” - Remove or significantly shorten so we get to solutions/new knowledge faster; we can highlight the main points but you can assume readers already work in geospatial and are familiar with the challenges
|
This PR has been updated and includes the addition of three new pages:
It still needs more work, but I think this structure works well. I'd like to also maybe add a more generic retrieval example in Python using ipfsspec for the retrieval guide. |
There was a problem hiding this comment.
Pull request overview
Adds new Scientific Data documentation content to the IPFS docs site, including a hands-on guide for publishing geospatial Zarr datasets and supporting context via a landscape overview and an ORCESTRA case study. Updates the VuePress sidebar to surface the new pages and case study.
Changes:
- Add a new “Publish Geospatial Zarr Data with IPFS” how-to guide.
- Add a new “Scientific Data and IPFS Landscape Guide” overview page.
- Add a new ORCESTRA case study and update VuePress navigation (including sidebar re-organization and case study list).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 20 comments.
| File | Description |
|---|---|
| docs/how-to/scientific-data/publish-geospatial-zarr-data.md | New step-by-step publishing guide (Zarr + IPFS), including discovery/access patterns. |
| docs/how-to/scientific-data/landscape-guide.md | New overview of scientific data formats, architectural patterns, and ecosystem tooling. |
| docs/case-studies/orcestra.md | New case study describing ORCESTRA’s use of IPFS for scientific data distribution. |
| docs/.vuepress/config.js | Adds the new Scientific Data pages to the How-to sidebar and adds ORCESTRA to case studies; also reorganizes peer-related sidebar entries. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Users can then access your data by using the `ipns://` prefix. | ||
|
|
||
| TODO: add example. |
There was a problem hiding this comment.
This section still contains a “TODO: add example.” placeholder. Please either add a concrete DNSLink + ipns://… (and/or gateway) example or remove the placeholder before merging so the guide reads as complete.
| Users can then access your data by using the `ipns://` prefix. | |
| TODO: add example. | |
| Users can then access your data by using the `ipns://` prefix. For example, if your Zarr store lives under a `my-zarr-dataset` directory, you can use: | |
| - IPNS URI: `ipns://data.example.org/my-zarr-dataset/` | |
| - HTTP gateway: `https://dweb.link/ipns/data.example.org/my-zarr-dataset/` |
| TODO: give an example with the `kubo ipfs files api` or maybe an asciicinema | ||
|
|
There was a problem hiding this comment.
This section contains a TODO placeholder. Please add the referenced example (or remove the TODO) before merging to avoid publishing incomplete guidance.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
What
Add a new “Publish Geospatial Zarr Data with IPFS” how-to guide.
Add a new “Scientific Data and IPFS Landscape Guide” overview page.
Add a new ORCESTRA case study and update VuePress navigation (including sidebar re-organization and case study list).
Preview: https://bafybeiectvvrc6c7tj7oyjsn5e4gh23tn2c5k5hv6r7n4tteslgzl3or2u.ipfs.dweb.link/how-to/publish-geospatial-data/