Add Boyd-orientation Stommel demo build script#29
Closed
madsCodeBuddy wants to merge 1 commit intomainfrom
Closed
Conversation
docs/build_demo_boyd.py is the canonical example showing how to use the package with space_on_x=False (time on x-axis, space on y-axis), the convention used in Boyd et al. (2015) and most BGC literature. Renders all 14 rows from data/datasets/stommel_boyd2015_volumes.csv with diffusion lines, magnitude labels along both axes, and the legend moved to the right of the plot via add_legend(p, position='right'). Output: docs/demo_stommel_boyd.html (442 KB).
Collaborator
Author
|
Closing — wrong scope. The actual demo is |
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
1 participant
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.
Summary
Add
docs/build_demo_boyd.py— the canonical example of using the package withspace_on_x=False(Boyd 2015 orientation: time on x-axis, space on y-axis). Companion tobuild_desert_farm.pywhich uses the same orientation.Why
The package's
create_space_time_figure()defaults tospace_on_x=True, which is the opposite of the Boyd (2015) and most BGC literature convention. Currently the only end-to-end Boyd-orientation example lives insidetests/test_local_install.py, which is not a documentation surface. Users wanting a Boyd-orientation starting point have nothing to copy from.What it does
Reads
data/datasets/stommel_boyd2015_volumes.csv(14 rows), runs throughtransform_predefined_processes, builds a figure viacreate_space_time_figure(space_on_x=False), layers diffusion lines + magnitude labels + processes, and places the legend on the right viaadd_legend(p, position="right").Verified orientation:
x_range: 0.001 .. 1e12with axis labelTime (s)y_range: 1e-21 .. 1e+21with axis labelSpace (m³)Files added
docs/build_demo_boyd.py— 50-line build script (black + flake8 clean)docs/demo_stommel_boyd.html— rendered output (442 KB, CDN mode)Out of scope