Skip to content
This repository was archived by the owner on Mar 16, 2023. It is now read-only.

Commit a366980

Browse files
authored
Merge branch 'master' into docker
2 parents 1670b95 + 65e3909 commit a366980

File tree

2 files changed

+27
-4
lines changed

2 files changed

+27
-4
lines changed

README.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,36 @@
22

33
# MindSphere Analytics Examples
44

5+
<!-- markdownlint-disable MD033 -->
6+
<img src="images/analytics-examples.svg" alt="mindconnect-nodejs" width="250px"/>
7+
<!-- markdownlint-enableMD033 -->
8+
9+
Examples how to use the mindSphere analytics APIs.
10+
511
[![The MIT License](https://img.shields.io/badge/license-MIT-009999.svg?style=flat)](./LICENSE.md)
6-
[![Documentation](https://img.shields.io/badge/mindsphere-documentation-%23009999.svg)](https://opensource.mindsphere.io/docs/mindconnect-nodejs/index.html)
12+
[![Documentation](https://img.shields.io/badge/mindsphere-documentation-%23009999.svg)](https://opensource.mindsphere.io/docs/analytics-examples/index.html)
713
[![Forum](https://img.shields.io/badge/mindsphere-community-%23009999.svg)](https://community.plm.automation.siemens.com/t5/Developer-Space/bd-p/MindSphere-platform-forum)
814

915
## Jupyter Notebooks demonstrating the use of the MindSphere Analytics APIs
1016

11-
- [Trend Prediction API](trend-prediction.ipynb)
12-
- [KPI Calculation API](kpi-calculation.ipynb)
13-
- [Spectrum Analysis API](spectrum-analysis.ipynb)
17+
18+
### Trend Prediction API
19+
20+
The Trend Prediction API predicts future values for time series using linear and nonlinear regression models. It is a forecasting framework, that has many useful applications in the area of Process & Condition Monitoring.
21+
22+
Example: [Trend Prediction API](trend-prediction.ipynb)
23+
24+
### KPI Calculation API
25+
26+
The KPI Calculation API computes Key Performance Indicators (KPIs) for an asset. It uses data sources such as sensors, control units and calendars.
27+
28+
Example: [KPI Calculation API](kpi-calculation.ipynb)
29+
30+
### Spectrum Analysis API
31+
32+
Spectrum Analysis API allows users to perform time domain and frequency domain analysis. It provides functions to transform a time-domain signal into its frequency components (via Discrete Fourier Transform) and to detect threshold breaches of their amplitudes.
33+
34+
Example: [Spectrum Analysis API](spectrum-analysis.ipynb)
1435

1536
## Running the notebook
1637

@@ -51,6 +72,7 @@ After that you can start using the jupyter lab with the notebooks. Just copy the
5172

5273
The docker image is based on [jupyter/scipy-notebook docker image](https://hub.docker.com/r/jupyter/scipy-notebook/).
5374

75+
5476
## Siemens API Notice
5577

5678
This project has been released under an [Open Source license](./LICENSE.md). The release may include and/or use APIs to Siemens’ or third parties’ products or services. In no event shall the project’s Open Source license grant any rights in or to these APIs, products or services that would alter, expand, be inconsistent with, or supersede any terms of separate license agreements applicable to those APIs. “API” means application programming interfaces and their specifications and implementing code that allows other software to communicate with or call on Siemens’ or third parties’ products or services and may be made available through Siemens’ or third parties’ products, documentations or otherwise.

images/analytics-examples.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)