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

Add application schema notes to docs #15

Open
thclark opened this issue Dec 17, 2019 · 0 comments
Open

Add application schema notes to docs #15

thclark opened this issue Dec 17, 2019 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thclark
Copy link
Collaborator

thclark commented Dec 17, 2019

Extracted from the old README.md of octue-app-python, and should be placed into the docs for the config schema strand:

## Application schema

For most applications, you need to supply some control parameters. For example:

 - In a simulation the user may want to specify the number of iterations or timesteps.
 - In a LiDAR analysis app, the user may want to know the deployment `lat/long` coordinates.
 - In a signal processing app, the user may want to turn on or off a particular step (e.g. smoothing of data).
 - In a Meteorological Mast analysis, the user may want to run analysis only for a specified date range.
 
It's the job of the application developer (that's you, probably) to **tell the end user what options are available**. 
The way this is done is via an **application schema**.

A **schema** describes precisely what inputs the application needs.

A **config** contains those inputs, and should match the schema.
@thclark thclark added the documentation Improvements or additions to documentation label Dec 17, 2019
@thclark thclark self-assigned this Dec 17, 2019
@thclark thclark added this to Twined v0.0.x in Twined Ecosystem Roadmap Nov 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant