Skip to content

Conversation

@rushirajnenuji
Copy link
Member

Add viz-workflow related docs

Add viz-workflow related docs
@rmarow
Copy link
Contributor

rmarow commented Nov 6, 2025

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.

@rushirajnenuji rushirajnenuji marked this pull request as ready for review December 2, 2025 20:21
@rmarow rmarow self-requested a review December 3, 2025 16:36
Copy link
Member

@trey-stafford trey-stafford left a 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`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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!

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