Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update publishing notebook example dataset #335

Open
ascourtas opened this issue Apr 24, 2023 · 0 comments
Open

Update publishing notebook example dataset #335

ascourtas opened this issue Apr 24, 2023 · 0 comments
Labels
documentation and examples Improvements or additions to documentation good first issue Good for newcomers

Comments

@ascourtas
Copy link
Contributor

As a Publisher, I want to have clear publishing examples that use data that is relevant to me and easy for me to compare my own data to

The current dataset publishing guide notebook uses the iris dataset, which is not only problematic, but also not a very useful guide for people with materials and chemistry datasets.

Assumptions:

  1. The current foundry publishing notebook example can be found here
  2. We have an idea of what dataset we want to replace it with (check in with Ben B)
  3. We anticipate Publishers would want a materials or chemistry related dataset

Acceptance Criteria

  1. Given the publishing notebook, a Publisher can easily understand how the example data relate to the metadata describing that data
  2. When a Publisher runs the notebook, it works without issue
  3. When a Publisher is trying to figure out how to write their own metadata, they can easily reference the metadata in the example notebook for guidance
  4. When a Publisher is trying to run the notebook locally, the downloaded dataset is small and lightweight and does not create bloat
@kjschmidt913 kjschmidt913 added good first issue Good for newcomers documentation and examples Improvements or additions to documentation labels Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation and examples Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants