Skip to end of metadata
Go to start of metadata

Overview of "View Modeler-Submitted Products" Use Case

View submitted model outputs based on ION data streams

Tip: Key Points
UC Priority= 4 or 5: Critical, is in R2
Only boldface steps are required
<#> before a step —> lower priority
(optional) —> run-time option

Related Jira Issues:   Open   •   All


Refer to the Product Description and Product Description Release 2 pages for metadata definitions.

Actors Data Analyst (Registered User), OOI science user (Registered User)
Uses UC.R2.01 Acquire Data From External Dataset
UC.R2.04 Browse to Get Data Product
Is Used By  
Is Extended By  
In Acceptance Scenarios AS.R2.03A Modelers Integrate External Model with OOI
Technical Notes  
Lead Team EOI
Primary Service IOOS Integration Package 2
Version 1.5.1
UC Priority 3
UC Status Mapped + Ready
UX Exposure EUC


This information summarizes the Use Case functionality.

Modeler gets data (pushed) from the Integrated Observatory, runs model, pushes resulting data set(s) into the Integrated Observatory. User can view the resulting data set(s), similarly to any other Integrated Observatory data set. The resulting data set has rich metadata including modeling algorithm and source provenance.


  • Modeler's data (to be published to the Integrated Observatory) has been registered in the Integrated Observatory already.
  • The model can be submitting data to the Integrated Observatory already (doesn't matter if so).

Initial State

Model exists and has been registered; a user is interested in discovering and subscribing to it.

Scenario for "View Modeler-Submitted Products" Use Case

  1. Any OOI science user browses a list of modeler-submitted data sets, chooses a data set and obtains its data identifier.
    1. Data identifiers can be found using many techniques, the particular one used doesn't matter (can even be by cutting and pasting it).
  2. Any OOI science user subscribes to the selected modeler-submitted data using data identifier obtained above.
    1. Now the OOI science user will wait, while the next contribution to the modeler-submitted data set is generated.
  3. Data is pushed from the Integrated Observatory to an outside operational model run by a Data Analyst.
    1. 'Outside' means the software is not running on the Integrated Observatory (although that would also work, it isn't the focus of this use case).
    2. Model reads the data as it arrives.
    3. Data arrival can trigger the model's execution. (it is not a required step, but a handy way to kick off the activity.)
  4. The model executes on Data Analyst's local machine, producing derived data (model) artifacts.
  5. The model's derived output is pushed to the Integrated Observatory through a communication channel previously established.
    1. Establishment of that channel required registration of the modeler, registration of the model as a data source, definition of the information pushed to ION by the model, and establishment of appropriate metadata to characterize that data stream and data source. See UC.R2.01 Acquire Data From External Dataset.
    2. Metadata also includes information about the modeling algorithm and the data source's provenance.
  6. Upon receipt of the model's output, the Integrated Observatory routes it to subscribed parties.
  7. The OOI science user in the second step receives the data.

Final State

OOI science user has received the model outputs.


These comments provide additional context (usually quite technical) for editors of the use case.

Implicitly includes a requirements for modelers to provide rich descriptive metadata. (This will set example for other data providers.)

Deciding whether a new run of the model provides a supplement in a stream, or a new version, is subtle. The optimal default is that each new run is a supplement, unless that run replaces a known faulty run (one that has a bug) – that would be a new version.

(click on # to go to R2 use case)
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
61     27B


r2-usecase r2-usecase Delete
usecase usecase Delete
productdescription productdescription Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.