Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quickstart guide, keyframing, small updates #14

Merged
merged 31 commits into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
fd62595
Adding draft outline for overview notebook
ifranda May 17, 2024
35964c8
Shortened metadata info
ifranda May 17, 2024
42cffb0
Descriptions for setup and renderers
ifranda May 22, 2024
6eef6b3
Quck fix
ifranda May 22, 2024
7c395e3
Annotation and export draft
ifranda May 24, 2024
dfe41e7
Keyframing notebook
ifranda May 28, 2024
9602207
Commented helper functions
ifranda May 28, 2024
12cf9f6
Title updates
ifranda May 28, 2024
6885805
Markdown updates
ifranda May 28, 2024
53941c2
Update markdown
ifranda May 29, 2024
01a6081
Test header
ifranda May 29, 2024
e2ab437
Revised descriptions
ifranda May 29, 2024
f834f15
Reformatting code that overhangs
ifranda May 29, 2024
f54d03f
Keyframing markdown descriptions
ifranda May 30, 2024
b68ee0a
Small changes to summaries and organization
ifranda May 30, 2024
7eb7696
Cleanup
ifranda May 31, 2024
c52eed4
Delete notebooks/keyframes directory - using google drive instead
ifranda May 31, 2024
dd13189
Adding quickstart guide after name change
ifranda May 31, 2024
6eda430
Merge branch 'ian-notebooks' of https://github.com/ProjectPythia/vapo…
ifranda May 31, 2024
e3fa4b0
Added automated data download
ifranda Jun 5, 2024
8ec533b
Update data access links
ifranda Jun 5, 2024
912a135
Updating -- no need for new Python script
ifranda Jun 5, 2024
6aa3e77
Skip download if done; will add this to keyframing notebook as well
ifranda Jun 5, 2024
f9bba23
Rework keyframing to work without downloads
ifranda Jun 5, 2024
ebdc53a
Link isn't live yet, removing for now
ifranda Jun 5, 2024
edaedf8
Add keyframe directory if it doesn't exist
ifranda Jun 5, 2024
9442633
Image renderer, can change later
ifranda Jun 6, 2024
dc3e46b
Quick fix
ifranda Jun 7, 2024
91a636a
Using image renderer for keyframing
ifranda Jun 7, 2024
b758a40
Using both image and 2D data
ifranda Jun 7, 2024
1725bd5
Markdown updates -- will proofread with preview website
ifranda Jun 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Visualization and Analysis Platform for Ocean, Atmosphere, and Solar Researc

## Authors

[Nihanth W. Cherukuru](https://github.com/NihanthCW), [Stanislaw 'Stas' Jarosynski](https://github.com/StasJ), [Philip Austin](https://github.com/phaustin)
[Nihanth W. Cherukuru](https://github.com/NihanthCW), [Stanislaw 'Stas' Jarosynski](https://github.com/StasJ), [Philip Austin](https://github.com/phaustin), [Ian Franda](github.com/ifranda)

### Contributors

Expand All @@ -23,11 +23,12 @@ The Visualization and Analysis Platform for Ocean, Atmosphere, and Solar Researc
<img src="https://github.com/shaomeng.png" width="8%" style="border-radius: 50%" />
<img src="https://github.com/clyne.png" width="8%" style="border-radius: 50%" />
<img src="https://github.com/NihanthCW.png" width="8%" style="border-radius: 50%" />
<img src="https://github.com/ifranda.png" width="8%" style="border-radius: 50%" />
</a>

## Structure

This cookbook is broken up into two main sections - "Foundations" and "Example Workflows". It is not necessary to go through these sections sequentially. Start with "Example Workflows" if you'd like to see VAPOR in action and get a broad overview of a workflow or start with "Foundations" if you'd like to explore the functionality/options in detail.
This cookbook is divided into three main sections. The "Quickstart" section is a good starting point for a general overview of VAPOR's features and capabilities. The "Foundations" section gives more detailed examples for specific features in VAPOR. The "Example Workflows" section provides practical examples to see VAPOR in action and to gain an understanding of various workflows. Feel free to visit the sections that best fit your needs -- it's not necessary to follow them sequentially!

### VAPOR Foundations

Expand Down
4 changes: 4 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ parts:
- caption: Preamble
chapters:
- file: notebooks/how-to-cite
- caption: Quickstart Guide
chapters:
- file: notebooks/quickstart

- caption: Foundations of VAPOR Python
chapters:
Expand All @@ -14,6 +17,7 @@ parts:
- file: notebooks/transfer_function_example
- file: notebooks/annotation_example
- file: notebooks/animation_example
- file: notebooks/keyframing_example
- file: notebooks/flow_example
- file: notebooks/visualizer_widget_example

Expand Down
40 changes: 40 additions & 0 deletions notebooks/camera_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
"# Controlling the Camera\n"
]
},
{
"cell_type": "markdown",
"id": "edc0386a",
"metadata": {},
"source": [
"Vapor provides several functions to control the camera position and direction. Here are a few examples."
]
},
{
"cell_type": "code",
"execution_count": 1,
Expand Down Expand Up @@ -79,6 +87,14 @@
"cam = ses.GetCamera()"
]
},
{
"cell_type": "markdown",
"id": "a798e780",
"metadata": {},
"source": [
"### View All"
]
},
{
"cell_type": "code",
"execution_count": 3,
Expand Down Expand Up @@ -121,6 +137,14 @@
"ses.Show()"
]
},
{
"cell_type": "markdown",
"id": "59f12f54",
"metadata": {},
"source": [
"### Align View"
]
},
{
"cell_type": "code",
"execution_count": 4,
Expand Down Expand Up @@ -163,6 +187,14 @@
"ses.Show()"
]
},
{
"cell_type": "markdown",
"id": "d0f6032e",
"metadata": {},
"source": [
"### Zoom"
]
},
{
"cell_type": "code",
"execution_count": 5,
Expand Down Expand Up @@ -204,6 +236,14 @@
"ses.Show()"
]
},
{
"cell_type": "markdown",
"id": "6abf0f67",
"metadata": {},
"source": [
"### Look At"
]
},
{
"cell_type": "code",
"execution_count": 6,
Expand Down
Loading
Loading