Update plotting documentation #351
Merged
Conversation
This file contains 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
rouille
reviewed
Aug 19, 2022
rouille
reviewed
Aug 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
After the latest release of powersimdata and postreise, any scenario can be loaded from blob storage, so there is no need to download a separate zip file in order to create the plots used in the tutorial. As such we can simplify the readme for this process.
What the code is doing
Update the readme, fix an issue saving the base64 encoded image data (not sure if this is due to a jupyter/ipython update to how outputs are handled, but didn't care enough to find out), and rerun the notebook to ensure it works. I also removed the pf snapshot from the output, which reduces the notebook size from 17MB to 20KB.
Testing
Regenerated the plots and did some spot checks between
docs/img(currently in git) anddocs/img2(where new outputs are written). So far I've only seen minor differences in the formatting, e.g. different sized image, but same plot. I'll continue looking into these but it should be fine.Usage Example/Visuals
Feel free to run the notebook.
Time estimate
10 min