Skip to content

Commit 9ae3185

Browse files
committed
Small readme updates
1 parent 6364b3b commit 9ae3185

4 files changed

Lines changed: 28 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ A collection of samples for use with [Predix Analytics](https://www.predix.io/do
44

55
## Sample Analytics
66

7-
These are sample analytics written for use with the Predix Analytics platform:
7+
These are sample analytics written for use with Predix Analytics:
88

99
- **[demo-adder](analytics/demo-adder):** A simple analytic that takes 2 numbers as input and returns their sum. It has been implemented in Java, Matlab (r2011b), and Python.
1010
- **[demo-timeseries-adder](analytics/demo-timeseries-adder-java):** Takes 2 arrays of timeseries data and returns a timeseries array that contains the sums at each timestamp. Currently available in Java.
1111
- **[demo-timeseries-adder-with-model](analytics/demo-timeseries-adder-with-model):** Takes 2 arrays of timeseries data and returns a timeseries array that contains the sums at each timestamp, adjusted by a threshold value provided in a trained model. Currently available in Java and Python.
1212
- **[demo-RTM-loco](analytics/demo-RTM-loco):** A reference analytic that is used to calculate locomotive efficiency using a linear regression model. It has been implemented in Java, Matlab (r2011b), and Python.
13+
- **[miners-rule](analytics/miners-rule):** A sample analytic that performs a Miner's Rule operation on 2 timeseries arrays and returns a timeseries array. Currently only available in Java.
1314

1415
For more information on developing analytics for use with Predix Analytics, see [Analytic Development](https://www.predix.io/docs/#Qd2kPYb7) on Predix IO.
1516

@@ -23,4 +24,10 @@ For more information on running orchestrations in Predix Analytics, see [Using t
2324

2425
**[Sample Postman Collections](postman)**
2526

27+
## Custom Data Connector
28+
29+
**[Sample Custom Data Connectors](custom-data-connector)
30+
31+
These are sample custom data connector implementations to connect to various data sources
32+
2633
Once you have created your instance of either the Analytics Catalog or Analytics Runtime service, you can use the sample Postman collections to customize your REST requests and test them out to aid in implementing your applications.

analytics/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Sample Analytics
22

3-
These are sample analytics written for use with the [Predix Analytics](https://www.predix.io/docs/#EG3xVdLg) platform:
3+
These are sample analytics written for use with [Predix Analytics](https://www.predix.io/docs/#EG3xVdLg):
44

55
- **[demo-adder](demo-adder):** A simple analytic that takes 2 numbers as input and returns their sum. It has been implemented in Java, Matlab (r2011b), and Python.
66
- **[demo-timeseries-adder-java](demo-timeseries-adder-java):** Takes 2 arrays of timeseries data and returns a timeseries array that contains the sums at each timestamp. Currently available in Java.
77
- **[demo-timeseries-adder-with-model](demo-timeseries-adder-with-model):** Takes 2 arrays of timeseries data and returns a timeseries array that contains the sums at each timestamp, adjusted by a threshold value provided in a trained model. Currently available in Java and Python.
88
- **[demo-RTM-loco](demo-RTM-loco):** A reference analytic that is used to calculate locomotive efficiency using a linear regression model. It has been implemented in Java, Matlab (r2011b), and Python.
9+
- **[miners-rule](miners-rule):** A sample analytic that performs a Miner's Rule operation on 2 timeseries arrays and returns a timeseries array. Currently only available in Java.
910

1011
For more information on developing analytics for use with Predix Analytics, see [Analytic Development](https://www.predix.io/docs/#Qd2kPYb7) on Predix IO.

custom-data-connector/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Sample Custom Data Connectors
2+
3+
These are sample custom data connector implementations to connect Predix Analytics to various data sources:
4+
5+
- **[postgres db implementation](postgresdb-ref-impl-data-connector)
6+
7+
For more information on developing custom data connector implementations for use with Predix Analytics, see [About Analytics Using an External Data Source](https://www.predix.io/docs/?r=336965#JgA3859v) on Predix IO.

orchestrations/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
## Sample Orchestration Workflows
1+
## Sample Orchestration Workflow Files
22

3-
A collection of sample orchestration workflows for use with Predix Analytics.
3+
A collection of simple orchestration workflow files for use with Predix Analytics.
44

55
1. **[Orchestration with one Catalog analytic](OrchestrationWithOneAnalytic.xml)**
66
2. **[Orchestration with one third-party analytic](OrchestrationWithThirdPartyAnalytic.xml)**
77
3. **[Orchestration with one Catalog analytic and one third-party analytic](OrchestrationWithTwoAnalytics.xml)**
88

99
A Catalog analytic is one that has been uploaded to the Analytic Catalog and deployed into Cloud Foundry.
1010

11+
## Complete Sample Orchestrations
12+
13+
Sample orchestrations that include all supporting files, such as orchestration workflow (BPMN), port-to-field maps, input/output data, and Postman collections
14+
15+
1. **[One step orchestration](oneStepOrchestration):** An orchestration using a single timeseries demo adder to add 2 timeseries arrays
16+
2. **[Multi step orchestration with Demo Adder](demoAdderMultiStepOrchestration):** An orchestration that adds 3 timeseries arrays by running the timeseries demo adder twice
17+
3. **[Multi step orchestration with Miner's Rule Analytic](multiStepOrchestration):** An orchestration that runs a Miner's rule operation on pre-processed output from a timeseries demo adder analytic
18+
19+
1120
For more information on running orchestrations in Predix Analytics, see [Using the Analytics Runtime Service](https://www.predix.io/docs/#pM5fe0l) on Predix IO.

0 commit comments

Comments
 (0)