How to Publish a CPTL Data Model

This tutorial describes a procedure to publish a CPTL Data Model.

1. Create Directory Structure

• Create a directory for your project. For example, in the CyPSA 8 Substation Model, the directory is called cypsa-8sub.
• Within the project directory, create the following subdirectories (Example: cypsa-8sub):
  • converters: Contains scripts to convert data sources to the CPTL Data Models included in the bundle (Example: cypsa-8sub/converters).
  • graphs: Contains the CPTL Data Models in JSON Node Link format (Example: cypsa-8sub/graphs).
  • ontologies: Contains the OWL ontologies used (Example: cypsa-8sub/ontologies)
  • resolvers: Used to define a mapping from a UUID to a CPTL graph (Example: cypsa-8sub/resolvers)
  • schemas: Contains schemas for each of the types of CPTL Data Models defined. These schemas are specified using jsonschema. (Example: cypsa-8sub/schemas)

2. Validate the Model

• Use the validation script to validate the CPTL Data Models relative to the defined schemas. See the cptlc/model-validator/README.

3. Document the Model

• Create an HTML page to document the model. (Example: cypsa-8sub )

4. Upload the Model

• This could be done via a pull request.

5. Register Model Location

• Let the CPTL Consortium know where your model is located!