Skip to content

Conversation

ktyle
Copy link
Contributor

@ktyle ktyle commented Jul 21, 2025

This PR updates the Data Access section in the Cookbook Contributor's guide. It can be used as a reference for the upcoming 2025 Summer Cook-off, as well as for any prospective Cookbook contributors.

@ktyle ktyle requested a review from a team as a code owner July 21, 2025 21:11
@ktyle ktyle requested review from dopplershift and brian-rose and removed request for a team July 21, 2025 21:11
@ktyle ktyle requested review from clyne and removed request for dopplershift July 21, 2025 21:11
Copy link
Contributor

github-actions bot commented Jul 21, 2025

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: 7ef8b51
✅ Deployment Preview URL: https://projectpythia.github.io/_preview/547

Copy link
Member

@brian-rose brian-rose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text looks great! I put in some suggestions for formatting fixes.

clyne
clyne previously approved these changes Jul 21, 2025
Copy link
Contributor

@clyne clyne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, @ktyle. Thanks!

BR suggested change 1

Co-authored-by: Brian Rose <brose@albany.edu>
BR suggested change 2

Co-authored-by: Brian Rose <brose@albany.edu>
@ktyle
Copy link
Contributor Author

ktyle commented Jul 22, 2025

The formatting is still off for section A part 4 ...

Copy link
Member

@brian-rose brian-rose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, if we don't like the formatting of the definition list, we could just use nested bullets under item 4.

For many concepts, we encourage writing self-contained functions to generate simple representative datasets for demonstrating scientific concepts. Your Cookbook can even reuse these sample data repeatedly throughout.

4. **For complex Cookbooks that rely on large datasets that are not already accessible through other services**, we suggest two options:
Institutional Repositories
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think adding a line break will fix the formatting:

Suggested change
Institutional Repositories
Institutional Repositories

Copy link
Member

@brian-rose brian-rose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great now, thanks @ktyle

@brian-rose brian-rose merged commit 47d3766 into ProjectPythia:main Jul 22, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request Jul 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants