Skip to content

Add scientific data and geospatial publishing guides & case study#2243

Open
2color wants to merge 12 commits intoipfs:mainfrom
2color:geospatial-guide
Open

Add scientific data and geospatial publishing guides & case study#2243
2color wants to merge 12 commits intoipfs:mainfrom
2color:geospatial-guide

Conversation

@2color
Copy link
Member

@2color 2color commented Jan 23, 2026

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/

@github-actions
Copy link
Contributor

github-actions bot commented Jan 23, 2026

🚀 Build Preview on IPFS ready

@mishmosh
Copy link
Collaborator

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:

  • Consider title “Scientific Data” as category
    • Ecosystem Tooling
    • Guide to Publishing Scientific Data
  • IPFS is used by the geospatial community for better collaboration, data integrity, and open access.
    (make sure we can describe some of the architectures used)
    • Connecting kubo to your existing data repositories (stac catalog)
    • Private clusters (but open retrieval) or “Collaborative publishing”
    • Provenance

@2color 2color marked this pull request as ready for review February 4, 2026 16:14
Copy link
Collaborator

@mishmosh mishmosh left a comment

Choose a reason for hiding this comment

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

A few suggestions and comments inline, but I'm confident you can take it from here. Would also like to see @vmx review.

2color and others added 6 commits February 6, 2026 14:34
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.
Copy link
Member Author

Choose a reason for hiding this comment

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

Note to self: add example

@2color 2color requested a review from vmx February 6, 2026 14:46
Comment on lines +103 to +105
--raw-leaves \
--chunker=size-1048576 \
--cid-version=1 \
Copy link
Member

Choose a reason for hiding this comment

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

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
Copy link
Member Author

Choose a reason for hiding this comment

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

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

@2color
Copy link
Member Author

2color commented Feb 13, 2026

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.

@2color 2color changed the title Add geospatial publishing guide Add scientific data and geospatial publishing guides & case study Feb 13, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment on lines +180 to +182
Users can then access your data by using the `ipns://` prefix.

TODO: add example.
Copy link

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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/`

Copilot uses AI. Check for mistakes.
Comment on lines +167 to +168
TODO: give an example with the `kubo ipfs files api` or maybe an asciicinema

Copy link

Copilot AI Feb 13, 2026

Choose a reason for hiding this comment

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

This section contains a TODO placeholder. Please add the referenced example (or remove the TODO) before merging to avoid publishing incomplete guidance.

Copilot uses AI. Check for mistakes.
mishmosh and others added 2 commits February 19, 2026 03:21
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments