MLMI2-CSSI / MLMI2-CSSI/foundry

Create HDF5 dataset publication notebook

Open
#183 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation and examples
Dominant language
Python
Stars
88
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Demonstrate to users how to publish an HDF5 dataset.

Create a new notebook called "hierarchical_dataset_publishing.ipynb" and add it to examples/publication_guides . Look at the existing data publication notebook for an idea of how to get started -- copy the overall format, but feel free to leave out the information about setting up Globus accounts (just add some markdown text pointing to the primary publishing notebook). That notebook is for publishing tabular data, but is a good place to start. Also look at the Foundry documentation for more info.

Contributor guide

No contributing guide indexed for this repository

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 with examples/publishing-guides/dataset_publishing.ipynb and the linked Foundry documentation; compare its structure with the HDF5 publication workflow. Create examples/publication_guides/hierarchical_dataset_publishing.ipynb, omit Globus setup in favor of markdown pointing to the primary publishing notebook, and verify that the notebook demonstrates HDF5 dataset publication.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
data, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.