Create a basic tutorial for DimensionalData - basic_tutorial.md#1198
Open
willbodeau wants to merge 28 commits into
Open
Create a basic tutorial for DimensionalData - basic_tutorial.md#1198willbodeau wants to merge 28 commits into
willbodeau wants to merge 28 commits into
Conversation
Adds a tutorial that introduces DimensionalData to users new to the package, using toy satellite data. Explains DimensionalData features in a real-world narrative, implementing features to address simplified, realistic questions. docs/src/dimensionaldata_tutorial.md: executable @example chunks and figures. docs/src/.vitepress/config.mts: add tutorial to navbar.
Increased the heatwave in toy data generation so it is clearly visible. Trim temperature output to just a preview
Add `nothing` to toy data generation chunk
Shorten them for simplicity, move on to tutorial content
Suppressed PRNG output, fixed phrasing describing dimension names for clarity
Suppress output. using semicolons instead of `nothing`, change title
dimensionaldata -> basic
Owner
|
Thanks! I will try to look through it later in the week |
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## main #1198 +/- ##
==========================================
- Coverage 86.99% 80.15% -6.84%
==========================================
Files 61 61
Lines 5850 5851 +1
==========================================
- Hits 5089 4690 -399
- Misses 761 1161 +400 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
felixcremer
reviewed
Jun 1, 2026
Update docs/src/basic_tutorial.md Co-authored-by: Felix Cremer <fcremer@bgc-jena.mpg.de>
alex-s-gardner
left a comment
alex-s-gardner
left a comment
Contributor
There was a problem hiding this comment.
This is a great start! Work through this review then we can discuss further.
asinghvi17
reviewed
Jun 15, 2026
Implemented wording suggestions to the TOC and throughout the tutorial. Added packages at beginning of tutorial
Replace satellite_data with climate as the variable name Refactor code for simplicity
Updated heatmaps of temperature to be more useful, concise. Fixed wording of things for accuracy
Refactor code for clarity: la/lo->lat/lo, lat/lon -> lats/lons throughout Expand one-liners into their individual components Update heatmaps for simplicity
Introduce `@dim` macro and explanation
Update headers, table of contents, anchor links
Add more motivation and explanation to the selector functions with basic examples.
Update data generation comments after changing from Kelvin to Celsius Suppress output using `nothing #hide`
Update TOC and headers, nest the `Question 1` headers so they dont appear in the sidebar.
Revise all parts of question 2 to use a more simple example to introduce dimension-aware broadcasting and stacks with non-matching layers.
Reword parts of question 2 for clarity
Correct grammar, punctuation, and sentence clarity. Change the code chunk that produces the intentional error so it doesn't execute Remove headers on the Questions 1 and 2 lines.
asinghvi17
reviewed
Jun 30, 2026
asinghvi17
left a comment
asinghvi17
left a comment
Collaborator
There was a problem hiding this comment.
Looks generally good, just some small suggestions
Co-authored-by: Anshul Singhvi <anshulsinghvi@gmail.com>
Co-authored-by: Anshul Singhvi <anshulsinghvi@gmail.com>
Co-authored-by: Anshul Singhvi <anshulsinghvi@gmail.com>
Co-authored-by: Anshul Singhvi <anshulsinghvi@gmail.com>
Co-authored-by: Anshul Singhvi <anshulsinghvi@gmail.com>
asinghvi17
reviewed
Jul 1, 2026
Co-authored-by: Anshul Singhvi <anshulsinghvi@gmail.com>
alex-s-gardner
left a comment
alex-s-gardner
left a comment
Contributor
There was a problem hiding this comment.
I think this is almost ready to merge
|
|
||
| To answer our second question, we will be working with arrays of two different shapes: the full temperature field (latitude, longitude, and time) and the global daily mean (time only). The motivation behind this is to demonstrate working with a DimStack whose layers don't completely match. | ||
|
|
||
| ## Build a DimStack of DimArrays with differing shared dimensions |
Changed sentence describing Bins as a function to describing it as a Type.
asinghvi17
approved these changes
Jul 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduces DimensionalData using toy satellite data, explaining the basics of the package: constructing DimArray and DimStack, lookups, selectors, groupby, constructing new stacks using set, dimension-aware broadcasting. Concepts are motivated by some simplified real world questions.
@alex-s-gardner