Skip to content

Updating documentation - #39

Draft
theoellingsen wants to merge 35 commits into
IntakeLoaderfrom
Documentation
Draft

Updating documentation#39
theoellingsen wants to merge 35 commits into
IntakeLoaderfrom
Documentation

Conversation

@theoellingsen

Copy link
Copy Markdown
Collaborator

Updated the documentation to reflect new functionality. Mostly updated the getting_started.ipynb notebook, added an 'advanced_usage.ipynb` that details some of the functionality not explained in the getting started notebook. Also added pages on contributing stolen from the ACCESS-intake-catalog documentation.

Add new plot options, allows user the choice between plotting a line graph and a heatmap. Adds choices for user to select x axis and y axis (when selecting a heatmap).
Adds button to remove plots, appends new plots rather than overwrites, groups them by whether they are user or reference plots
Add user options to select how data is sliced, finds which dimensions remain after x/y axis are chosen, and prompts the user to choose how they are sliced
Error handling for some user choices that break things and minor bug fixes
…ls etc)

Adds important information to plot caption, generated from if the data is sliced, and what model and dataset the plot is created from
…e doing that

Making more robust error handling that handles errors caused by invalid entries in the UI.
…rence datasets

Add functionality to plot user data overlayed with any number of reference datasets. Adds UI to add reference model datasets to a dictionary, and plots them.
add animation option to dropdown for model plotting

Revert "add animation option to dropdown for model plotting"

This reverts commit 39d59c4.

Revert "Attempt at adding animated plots"

This reverts commit 91456e2.

Reapply "Attempt at adding animated plots"

This reverts commit 2bc879a.

Reapply "add animation option to dropdown for model plotting"

This reverts commit b373623.

Add animation axes choices for user dataset

Fix so that HTML actually loads in widget

Trying animation without html with just the hvplot panel object, cleaner if it works

Add scrubber to animation

Lazy load the animation

Add reference animation functionality, and change colour map for animated plots to match xarray heatmap default

Update ref UI so that animation options appear when they are supposed to.

Initialise fig and fig animated in ref plot data button click function

ensure ref plot is actually plotting ref animation rather than user data animation

Update to only show the dimensions available to that variable in plot options

Update animation plots to use variable as title, and include captions with slice information.

Fix animation figure title, make animation bigger?
Adding new option to plot user vs ref data heatmaps on a grid together.
…data and reference data. Works for heat maps and line graphs

Add functionality allowing user to plot the difference between their data and reference data. Works for heat maps and line graphs
Add toggles for long/ short var names, for all different plot types

Add multiplot variable long name toggle

Add toggle for reference variable too

Add toggle for reference variable too
…h as SeaIce can load.

Cleaning stuff up a bit, adding docstrings, and ensuring datasets such as SeaIce can load. Also fixes issue with animation that caused plot to not be created for SeaIce datasets.
Comment thread docs/_static/ACCESS Logo 2024 (RGB).png
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