ioos / ioos/xarray-subset-grid

We need test datasets / files!

Open
#33 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

GSoC: 2026 Testing / CI
Dominant language
Python
Stars
9
Forks
11
Avg merge
3d 7h
Merged PRs (30d)
4

Description

For the tests, and for development, it's really good to have datasets you can work with without downloading anything.

I think we should have three sets of data / files:

  1. really tiny (probably hard coded in Python code) examples of various file types, metadata types, etc, for the tests. These could be hand written, or borrowed from other projects.

There are some in the gridded project:

https://github.com/NOAA-ORR-ERD/gridded

There are some examples of UGRID and SGRID files and data sets:

https://github.com/NOAA-ORR-ERD/gridded/blob/master/gridded/tests/gen_analytical_datasets.py

https://github.com/NOAA-ORR-ERD/gridded/tree/master/gridded/tests/test_ugrid/files

https://github.com/NOAA-ORR-ERD/gridded/blob/master/gridded/tests/test_pysgrid/write_nc_test_files.py

  1. small-ish real examples -- so far, I've put one UGRID (FVCOM, triangular mesh) example in:

xarray-subset-grid/examples/example_data/SFBOFS_subset1.nc

I set up git LFS support, I think that means all *.nc files will be stored in LFS, so we an put medium sized files in there -- but probably don't want to go more than 10MB or so.

There's a bit of a chicken-egg problem there -- how do you make a small file if you don't yet have a tool to subset larger ones with?

But at this point, we do have some working subset code, so I think we could do:

  • get the subset code working
  • make a small test file with it
  • add that file, and build your more comprehensive tests against it.
  1. larger test files

These could be stored somewhere else, and downloaded on demand -- one option would be in gitHub as releases or packages, or ???

We can also have test code, etc, that points to what we know are stable resources on S3, etc. -- already some of that in the examples.

Maybe have a file in the repo with a set of links to various datasets?

@omkar-334: maybe you could put together a small example or two of ADCIRC (STOFS2D).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing subset code and the example file at xarray-subset-grid/examples/example_data/SFBOFS_subset1.nc, then compare the fixture examples linked from gridded. Determine how the proposed tiny, small, and larger dataset tiers would be represented and stored. Done requires an agreed dataset plan with usable fixtures or stable download references for the tests and development workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.