Skip to content

README.md

Latest commit

 

History

History
67 lines (46 loc) · 1.45 KB

README.md

File metadata and controls

67 lines (46 loc) · 1.45 KB

cloudscope-data

Sample datasets for CloudScope and AcqStore.

The app downloads release zip archives at runtime. The data repo should remain separate from the main cloudscope Python package so packaged desktop apps stay small and sample data can be updated independently.

Current samples

demo-small

Small example dataset for CloudScope development and demos.

Contents:

  • two condition folders: cond1/ and cond2/
  • raw Olympus OIR files
  • AcqStore sidecar JSON metadata
  • saved diameter analysis CSV files
  • saved Radon velocity analysis CSV files

Archive convention:

demo-small-v1.zip
  demo-small/
    cond1/
    cond2/

Build the archive from the parent directory with:

zip -r demo-small-v1.zip demo-small

Release process

  1. Create or update the sample folder.

  2. Build the versioned archive:

    zip -r demo-small-v1.zip demo-small

  3. Compute the SHA-256 hash:

    shasum -a 256 demo-small-v1.zip

  4. Create a GitHub release, for example v0.1.0.

  5. Upload demo-small-v1.zip as a release asset.

  6. Update src/acqstore/sample_data.py in the main cloudscope repo if the URL, version, or hash changed.

Expected release asset URL:

https://github.com/mapmanager/cloudscope-data/releases/download/v0.1.0/demo-small-v1.zip

Notes

Do not add extra metadata files inside the sample dataset unless AcqStore itself needs them. Document dataset contents in this README instead.