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

Introduction to MindSphere Analytics APIs - The notebooks use @mindconnect/mindconnect-nodejs CLI for API calls.

License

Notifications You must be signed in to change notification settings

mindsphere/analytics-examples

Repository files navigation

MindSphere Analytics Examples

mindconnect-nodejs

Examples how to use the mindSphere analytics APIs.

The MIT License Documentation Forum

Jupyter Notebooks demonstrating the use of the MindSphere Analytics APIs

Trend Prediction API

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.

Example: Trend Prediction API

KPI Calculation API

The KPI Calculation API computes Key Performance Indicators (KPIs) for an asset. It uses data sources such as sensors, control units and calendars.

Example: KPI Calculation API

Spectrum Analysis API

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.

Example: Spectrum Analysis API

Running the notebook

The easiest way to run the notebook is to use mindspheredemos/analytics-examples docker container.

You can either build the container locally

docker build .

or you can pull the container from docker hub.

docker pull mindspheredemos/analytics-examples

You can run the container using following command:

docker run -it -p:8888:8888 -p:4994:4994 --name examples mindspheredemos/analytics-examples

The container will offer two endpoints:

Please configure the CLI with app credentials as described here

After that you can start using the jupyter lab with the notebooks. Just copy the token from the container output. The notebooks can be found in work folder.

jupyter lab

(If you have started the container in the background you can get the token by running docker logs examples command.)

Docker Base Image

The docker image is based on jupyter/scipy-notebook docker image.

Siemens API Notice

This project has been released under an Open Source license. 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.