Skip to end of metadata
Go to start of metadata

Modelers Integrate External Model with OOI

Integrate OOI capabilities with a model developed externally.


Addresses the OOI elements that come into play when a model developer decides to integrate OOI capabilities with the model he or she has developed. Includes the following modeler activities:

  • Data identification — An end user wanting to find data of interest for a model: data (and metadata) browse, search, and navigation, visualization of data products, and data specification.
  • Model integration — Data subscription, modification of the model and associated software to accept and process data updates, data presentation (for compatibility with OOI)
  • Data publication — The submission of model products as data sets to OOI, including data publication registration, management of existing publication registrations, providing provenance and other metadata, versioning data, and submission of data supplements.

Review Status Ready for OOI Review
AS Priority 4
AS Version 3.1.1
Issues Status (Jira) OverviewAllUnresolved
Custom Issues Lists Marine IO ReviewMarine IO ProcessesCI IO Verify

The custom issue lists are as follows. They include both open tasks, and tasks marked as fixed.

  • Marine IO Review issues are called to the attention of the Marine IOs for their review.
  • Marine IO Processes issues are expected to require further consideration/understanding of the Marine IO processes.
  • CI IO Verify issues are generally resolved, but the resolution needs to be confirmed with appropriate CI experts.


Related Use Cases

Use Cases Mapped to This Scenario

The following Use Cases have been mapped to this Acceptance Test Scenario:

Use Cases Cited by This Scenario

This Acceptance Test Scenario cites the following Use Cases:


This text style = background material
This text style = priority <3> (not required).

( ) Indicates footnoted material targeted for Release 3.
( ) Indicates footnoted material targeted for Release 4.
[MI] , [Ops] Provided by MI or Ops team (has no use case).
[NoUC] indicates material for which no Use Case exists.

Overview Diagram

Click on the thumbnail image to pop-up a full-width image, or see image on its own page.


Registered User: A user who has an explicitly identified ION account. (The user also must have permission to submit data to the Integrated Observatory.)

End-to-End Scenario

Identify Necessary Data

Relevant Use Cases
UC.R2.04 --- Browse to Get Data Product
UC.R2.18 --- Visualize Data Product
UC.R2.24 --- Search for Resource
UC.R2.21 --- Transform Data in a Workflow
UC.R2.26 --- Navigate Resources and Metadata

Dr. S logs into the ION system and uses the search and filtering capabilities to identify data that he wishes to integrate into his model system. (See UC.R2.04 Browse to Get Data Product and UC.R2.24 Search for Resource.) Dr. S can visualize the data he finds to help determine its usefulness. (See UC.R2.18 Visualize Data Product.) For each data set he identifies as useful, Dr. S creates a subscription to that data so that the data can be delivered to him as it becomes available.

In some cases Dr. S may need to transform the data to a format he finds more suitable; this occurs after he has received the data. ( 1 )

Future Release Notes
Release 3

Integrate OOI Data as Model Inputs

Dr. S configures his model and/or pre-processing software such that the data delivered by the Integrated Observatory system is utilized. The model may utilize the data as it arrives, and/or the arrival of data may also trigger model execution. Neither of these are required steps — Dr. S is free to configure the use of OOI data within his model as he sees fit — but may provide a convenient means by which to automate the initiation of the model execution.

Prepare Model Outputs

Relevant Use Cases
UC.R2.29 --- Integrate External Data Source

The output from Dr. S's model must be well characterized in terms of its form and content, and Dr. S must also describe the provider, the model algorithm, data sources, and other relevant information, similar to the provenance provided by internal Integrated Observatory processes (reference for example UC.R2.21 Transform Data in Workflow.). Dr. S must register the model output data as a data product with the Integrated Observatory. (See UC.R2.29 Integrate External Dataset.)

In some cases, the model output may require modification to be fully compatible with OOI-CI data requirements. Dr. S can do this by post-processing the model output, so as to not modify the original model output. This final transformation should be described in the provenance metadata for the data set.

Publish Model Data to OOI

Relevant Use Cases
UC.R2.01 --- Acquire Data From External Data Source
UC.R2.04 --- Browse to Get Dataset
UC.R2.18 --- Visualize Data Product
UC.R2.32 --- Conduct Negotiation
UC.R2.35 --- Share Affiliated Orgs' Resources
UC.R2.36 --- Create an Org
UC.R2.53 --- View Modeler-Submitted Products

After successful completion of a model run, the resulting model output data is published to the Integrated Observatory system from Dr. S's modeling environment. The data arrives in the system and is delivered to any users who have subscribed to the data set. The data is also available within the Integrated Observatory system for browsing, searching and visualization. (See UC.R2.01 Acquire Data From External Dataset, [UC.R2.04 Browse to Get Dataset], UC.R2.18 Visualize Data Product, UC.R2.34 Share an Org Resource, and UC.R2.53 View Modeler-Submitted Products.)

( 1 )

Release 3

Update Subscriptions and Publications

Relevant Use Cases
UC.UC.R2.22 --- Version Data Set

Dr. S wants to update his subscriptions to use a new data set in place of one of his existing data sets. He goes to a page in the Integrated Observatory that shows his subscriptions, thinking he can edit the source of a subscription. In fact, all he can do is add a new subscription and delete the old one. To keep his own system up and running, he adds the new subscription first, and verifies it is operational. Then he is ready to modify his own software to use the new subscription, but he has to change his publications first, since the data it is using is now different.

So he visits his publications management page. In this case, he will do things in a similar order, changing the description of the existing publication. In Release 2, this has to be synchronized with the modification to his software, so that each data update has correct metadata. ( 1 )

Now, he can change the subscription used by his software to the new one created earlier in OOI. If he is sure he has no software using the old subscription, he removes the old subscription from his subscription management interface.

After a time, Dr. S realizes that there is a bug in his model, and it affected all the data produced so far (2 months of publication to the Integrated Observatory). First he fixes his model to eliminate the bug, and he updates the metadata it produces to reflect its new version. He will change his publications in the Integrated Observatory similar to the above, but this time he has to indicate that the previous publication has been deprecated. He is now providing a new version of the publication. He checks the appropriate box in the publications management page to indicate this is a new version, and submits the modified publication metadata information. (See UC.R2.22 Version Data Set.) This effectively creates a new data product in the Integrated Observatory (because users could explicitly ask to see either data product), annotating the previous product as deprecated, and establishes the relation between the two. Users can see the product is deprecated by its metadata, or by visible indications or even omissions in user interface views .

As was the case when the Product Transform was updated in AS.R2.04A Data Product Leads Drive Core Data Product Creation, he can now re-run his algorithm against the historical input data, and resubmit the corrected output data. The submission of the new version of this data will deprecate the existing data, as described above. ( 2 )

Future Release Notes
Release 3


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