Add scientific data and geospatial publishing guides & case study by 2color · Pull Request #2243 · ipfs/ipfs-docs

2color · 2026-01-23T15:16:10Z

What

Adds new documentation focused on scientific/geospatial data publishing with IPFS (Zarr + tooling), plus an ORCESTRA case study and related VuePress navigation updates, with a small quickstart retrieval enhancement.

Changes:

Added “Scientific data and IPFS landscape guide” and “Publish geospatial Zarr data with IPFS” how-to pages.
Added ORCESTRA case study and updated VuePress sidebar/navigation to include the new section + case study.
Extended retrieval quickstart with a Python/ipfsspec verified retrieval example and updated spellcheck ignore list.

github-actions · 2026-01-23T15:17:52Z

🚀 Build Preview on IPFS ready

🔎 Commit: b174ac9
🔏 CID bafybeiblnp6fa3uv5a2r7nk3opx2xfkxxu6pkz7wvphnzfimc6ukkv4w5u
📦 Preview:
- dweb.link
- inbrowser.link

mishmosh · 2026-01-23T15:36:52Z

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

mishmosh

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

docs/how-to/publish-geospatial-data.md

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

Co-authored-by: Volker Mische <volker.mische@gmail.com>

Co-authored-by: Mosh <1306020+mishmosh@users.noreply.github.com>

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

lidel · 2026-02-06T17:44:32Z

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

+         --raw-leaves \
+         --chunker=size-1048576 \
+         --cid-version=1 \


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

docs/how-to/scientific-data/landscape-guide.md

Copilot

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.

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

docs/how-to/scientific-data/landscape-guide.md

docs/case-studies/orcestra.md

docs/how-to/scientific-data/landscape-guide.md

docs/case-studies/orcestra.md

docs/.vuepress/config.js

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

In the rest of the docs we mostly use sentence casing.

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 12 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/how-to/scientific-data/landscape-guide.md

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

Copilot · 2026-02-24T08:08:28Z

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

+ds = xr.open_dataset(filename)
+# Example: targeting ~1 MB chunks with float32 data
+ds.to_zarr('output.zarr', encoding={
+    'var_name': {'chunks': (1, 512, 512)}


The chunking example uses undefined placeholders (filename, var_name), which will error if readers copy/paste. Consider making these explicit string placeholders (e.g., "path/to/file" / "variable_name") or adding a short comment that they must be replaced.

Suggested change

ds = xr.open_dataset(filename)

# Example: targeting ~1 MB chunks with float32 data

ds.to_zarr('output.zarr', encoding={

'var_name': {'chunks': (1, 512, 512)}

filename = "path/to/your/file.nc" # Replace with the path to your dataset

ds = xr.open_dataset(filename)

# Example: targeting ~1 MB chunks with float32 data

ds.to_zarr('output.zarr', encoding={

'variable_name': {'chunks': (1, 512, 512)} # Replace with the name of your variable

docs/how-to/scientific-data/publish-geospatial-zarr-data.md

docs/quickstart/retrieve.md

docs/how-to/scientific-data/landscape-guide.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

lkluft

Thanks for adding this really nice article about ORCESTRA!

I made a couple of minor suggestions, but I do like the overall story very much! 👍

lkluft · 2026-02-24T11:39:34Z

docs/case-studies/orcestra.md

+<NumberBlock :items="[
+  {value: '20+', text:'Research institutions'},
+  {value: '8', text: 'Sub-campaigns'},
+  {value: '50+', text: 'Participating organizations'},


Suggested change

{value: '50+', text: 'Participating organizations'},

{value: '50+', text: 'Scientists on-site'},

lkluft · 2026-02-24T11:45:00Z

docs/case-studies/orcestra.md

+
+[ORCESTRA](https://orcestra-campaign.org/) (Organized Convection and EarthCARE Studies over the Tropical Atlantic) is an international field campaign that launched in early 2024 to study tropical mesoscale convective systems: the storm systems that play a significant role in the Earth's weather and climate dynamics.
+
+The campaign brings together **over twenty scientific institutions** spanning Europe, North America, and Africa. Eight sub-campaigns (three airborne, one land-based, and four at sea) coordinate aircraft, ships, ground stations, and satellites to collect atmospheric measurements across the tropical Atlantic.


While we did perform overflights with several satellites, one might mention EarthCARE explicitly (as it also comes up in the name).

Suggested change

The campaign brings together **over twenty scientific institutions** spanning Europe, North America, and Africa. Eight sub-campaigns (three airborne, one land-based, and four at sea) coordinate aircraft, ships, ground stations, and satellites to collect atmospheric measurements across the tropical Atlantic.

The campaign brings together **over twenty scientific institutions** spanning Europe, North America, and Africa. Eight sub-campaigns (three airborne, one land-based, and four at sea) coordinate aircraft, ships, and ground stations to collect atmospheric measurements across the tropical Atlantic and validate observations made by the [EarthCARE](https://earth.esa.int/eogateway/missions/earthcare) satellite, which was launched shortly before the start of the campaign.

lkluft · 2026-02-24T11:47:10Z

docs/case-studies/orcestra.md

+
+## How ORCESTRA works
+
+ORCESTRA's eight sub-campaigns span sea, air, and land, collecting atmospheric measurements such as temperature, humidity, wind, radiation, aerosols, and cloud properties. This observational data is structured as multidimensional arrays and stored primarily in the [Zarr](https://zarr.dev/) format, a cloud-native format optimized for chunked, distributed access to large scientific datasets.


Suggested change

ORCESTRA's eight sub-campaigns span sea, air, and land, collecting atmospheric measurements such as temperature, humidity, wind, radiation, aerosols, and cloud properties. This observational data is structured as multidimensional arrays and stored primarily in the [Zarr](https://zarr.dev/) format, a cloud-native format optimized for chunked, distributed access to large scientific datasets.

ORCESTRA's eight sub-campaigns cover sea, air and land. They collect atmospheric measurements such as temperature, humidity, wind, radiation, aerosols and cloud properties, as well as oceanic measurements such as sea-surface temperature, salinity and ocean currents. This observational data is structured as multidimensional arrays and stored primarily in the [Zarr](https://zarr.dev/) format, a cloud-native format optimized for chunked, distributed access to large scientific datasets.

2color added 2 commits January 23, 2026 14:42

chore: move kubo specific guides into kubo categorty

fecc47d

initial draft of geospatial guide

0aac21d

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

mishmosh approved these changes Feb 4, 2026

View reviewed changes

vmx reviewed Feb 5, 2026

View reviewed changes

docs/how-to/publish-geospatial-data.md Outdated Show resolved Hide resolved

docs/how-to/publish-geospatial-data.md Outdated Show resolved Hide resolved

docs/how-to/scientific-data/publish-geospatial-zarr-data.md Show resolved Hide resolved

2color and others added 6 commits February 6, 2026 14:34

Apply suggestion from @vmx

12eab53

Co-authored-by: Volker Mische <volker.mische@gmail.com>

Apply suggestion from @mishmosh

fd6337f

Co-authored-by: Mosh <1306020+mishmosh@users.noreply.github.com>

Apply suggestion from @mishmosh

45d15d2

Co-authored-by: Mosh <1306020+mishmosh@users.noreply.github.com>

address feedback and refine guide

3e75109

reorg into folder

8811dd5

chore: add TODO

3be1cd3

2color commented Feb 6, 2026

View reviewed changes

docs/how-to/scientific-data/publish-geospatial-zarr-data.md Outdated Show resolved Hide resolved

2color requested a review from vmx February 6, 2026 14:46

lidel reviewed Feb 6, 2026

View reviewed changes

vmx approved these changes Feb 9, 2026

View reviewed changes

2color added 2 commits February 13, 2026 17:18

docs: add landscape guide

f22d621

docs: add orcestra to case studies

e2b3a6e

2color commented Feb 13, 2026

View reviewed changes

docs/how-to/scientific-data/landscape-guide.md Outdated Show resolved Hide resolved

2color requested a review from Copilot February 13, 2026 16:31

Copilot started reviewing on behalf of 2color February 13, 2026 16:31 View session

This comment was marked as outdated.

Sign in to view

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

Copilot AI reviewed Feb 13, 2026

View reviewed changes

mishmosh and others added 5 commits February 19, 2026 03:21

Update docs/how-to/scientific-data/publish-geospatial-zarr-data.md

5183006

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestions from code review

85b9dac

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Address feedback and refine

1883049

Add python example to python quickstart guide

04e3302

Refine

b3883b4

2color added 4 commits February 23, 2026 13:00

Add MFS and pin names examples & link content

6ca1fdd

Use sentence casing consistently and fix links

f550f1d

In the rest of the docs we mostly use sentence casing.

Add new words to voab

4ef4dd8

Appease markdown link checker

ff5c629

2color force-pushed the geospatial-guide branch from 1bfb8d4 to ff5c629 Compare February 23, 2026 14:55

2color added 4 commits February 23, 2026 16:00

fix vocab

c2c8c0a

Refine, edit, and add more info on content routing

8eb1337

Add more information about DNSLink to zarr guide

5f014ab

fix typos

59f35d7

2color requested review from Copilot, mishmosh and vmx February 23, 2026 17:24

Copilot started reviewing on behalf of 2color February 24, 2026 08:02 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

2color and others added 3 commits February 24, 2026 10:48

Fix typos

abcf425

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/how-to/scientific-data/landscape-guide.md

624f38e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/how-to/scientific-data/publish-geospatial-zarr-data.md

b174ac9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

lkluft approved these changes Feb 24, 2026

View reviewed changes

	{value: '50+', text: 'Participating organizations'},
	{value: '50+', text: 'Scientists on-site'},


		[ORCESTRA](https://orcestra-campaign.org/) (Organized Convection and EarthCARE Studies over the Tropical Atlantic) is an international field campaign that launched in early 2024 to study tropical mesoscale convective systems: the storm systems that play a significant role in the Earth's weather and climate dynamics.

		The campaign brings together over twenty scientific institutions spanning Europe, North America, and Africa. Eight sub-campaigns (three airborne, one land-based, and four at sea) coordinate aircraft, ships, ground stations, and satellites to collect atmospheric measurements across the tropical Atlantic.


		## How ORCESTRA works

		ORCESTRA's eight sub-campaigns span sea, air, and land, collecting atmospheric measurements such as temperature, humidity, wind, radiation, aerosols, and cloud properties. This observational data is structured as multidimensional arrays and stored primarily in the [Zarr](https://zarr.dev/) format, a cloud-native format optimized for chunked, distributed access to large scientific datasets.

Comments

Conversation

2color commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Uh oh!

github-actions bot commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Build Preview on IPFS ready

Uh oh!

mishmosh commented Jan 23, 2026

Uh oh!

mishmosh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lidel Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as outdated.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lkluft left a comment

Choose a reason for hiding this comment

Uh oh!

lkluft Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

lkluft Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

lkluft Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2color commented Jan 23, 2026 •

edited

Loading

github-actions bot commented Jan 23, 2026 •

edited

Loading