-
Notifications
You must be signed in to change notification settings - Fork 0
Add viz-workflow related docs #113
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
base: main
Are you sure you want to change the base?
Conversation
Add viz-workflow related docs
|
This is a great start. I think once we figure out merging the other PR's we may need to edit some of the docs to reflect those changes, but that can always be done in the future. |
trey-stafford
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking great - I have a couple of suggested changes but fine to merge once you've reviewed those.
|
|
||
| #### Configuration | ||
|
|
||
| In addition to `meta.yaml`, `visualization` workflows require a `config.json` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| In addition to `meta.yaml`, `visualization` workflows require a `config.json` | |
| In addition to `meta.yaml`, `visualization` workflows can include a `config.json` |
config.json is not required - if not specified, the default is {}.
|
|
||
| Raster input support (GeoTIFF) is planned for future releases. | ||
|
|
||
| #### Use Cases |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great!
|
|
||
| The visualization workflow is powered by several specialized Python packages: | ||
|
|
||
| - **viz-workflow**: The main orchestrator that coordinates configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's link to each of the packages (e.g., https://github.com/PermafrostDiscoveryGateway/viz-workflow/) to make it clear that these are external dependencies of the ogdc.
| - Tile Matrix Set (TMS) for tiling strategy | ||
| - Statistical calculations to perform | ||
| - Color palettes for visualization | ||
| - Output specifications |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any information on what fields are expected/allowed here? E.g., if I want to change the color palettes, how would I go about doing that? Linking to the appropriate PDG docs here would be great!
Add viz-workflow related docs