Modules and packages
Icon | Description |
---|---|
Ⓒ | Common modules that are CDF project wide and shared by other modules. |
Ⓜ | Modules that define a distinct capability or feature. |
Ⓔ | Example modules that contain example data or that can be copied and used as a starting point for new modules. |
Ⓧ | Experimental modules that are not ready for production use, but that can be used for experimentation and exploration. |
This is an overview of the Cognite official modules and packages. The modules have their
README.md
files in a public repository where you can
also contribute improvements and new modules.
Package | Modules | Description |
---|---|---|
DATA_MODEL_EXAMPLES | A tutorial to start using data models | |
cdf_auth_readwrite_all Ⓒ | Default access group for the cdf-tk tool. | |
cdf_oid_example_data Ⓧ | Example data from Open Industrial Data. | |
cdf_apm_simple_data_model Ⓧ | Simplified example data model for Asset Performance Management (APM) use cases. | |
CDF_DEMO_INFIELD | A fully working demo for Infield with sample data | |
cdf_auth_readwrite_all Ⓒ | Default access group for the cdf-tk tool. | |
cdf_oid_example_data Ⓧ | Example data from Open Industrial Data. | |
cdf_apm_base Ⓜ | Basic data models for Asset Performance Management (APM) projects, including Infield and Maintain. | |
cdf_infield_common Ⓜ | Common configurations for Infield that are only needed once per CDF project. | |
cdf_infield_location ⓂⒺ | Per location configurations necessary when setting up a new location for Infield. | |
cdf_data_pipeline_asset_valhall ⓂⒺ | A package that implements a data pipeline ingesting data into RAW tables ready for transformations into asset hierarchy and data models. | |
CDF_INFIELD | Production-ready package for Infield | |
cdf_auth_readwrite_all Ⓒ | Default access group for the cdf-tk tool. | |
cdf_apm_base Ⓜ | Basic data models for Asset Performance Management (APM) projects, including Infield and Maintain. | |
cdf_infield_common Ⓜ | Common configurations for Infield that are only needed once per CDF project. | |
cdf_infield_location ⓂⒺ | Per location configurations necessary when setting up a new location for Infield. | |
EXAMPLE_PUMP | Example data models that extend the core Asset data model | |
example_pump_asset_hierarchy Ⓔ | RAW data tables, data set, and transformation to load pump data into asset hierarchy. | |
cdf_asset_source_model Ⓧ | Example extended Asset data model for the pump asset hierarchy extending the core Asser data model. | |
example_pump_data_model Ⓧ | Example Pump and LiftStation data models extending the extended Asset. | |
WITHOUT PACKAGE | Modules that are not part of a package | |
cdf_functions_dummy Ⓧ | Example module for deploying Cognite Functions. |
Older versions of the templates
The above module documentation links are to the latest released versions of the modules.
If you have an older version of the templates in your project, you will find the correct module documentation
in the README.md file in the root directory of the module in the cognite_modules/
directory of your project.