You've already forked generic-industrial-process
Import UAPF package
This commit is contained in:
26
docs/00-charter.md
Normal file
26
docs/00-charter.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# OIPF Generic Industrial Process Library — Charter
|
||||
|
||||
## Mission
|
||||
|
||||
Create a reusable ProcessGit library for AI-native production operations. The library defines a generic industrial process pattern that can be adapted to factories, process plants, utilities, and industrial facilities.
|
||||
|
||||
## Scope
|
||||
|
||||
The first scope is the operational intelligence loop:
|
||||
|
||||
```text
|
||||
Observe → Contextualise → Infer → Check → Recommend → Approve → Act → Record → Learn
|
||||
```
|
||||
|
||||
The library is neutral and not tied to any single vendor, plant, sector, or runtime.
|
||||
|
||||
## Out of scope
|
||||
|
||||
- Direct PLC/DCS control logic.
|
||||
- Hard real-time safety functions.
|
||||
- Replacement of OPC UA, ISA-88, ISA-95, MES, SCADA, historians, or ERP.
|
||||
- A universal ML model for every factory.
|
||||
|
||||
## Design principle
|
||||
|
||||
The library should help turn industrial AI projects from bespoke consulting into reusable production-intelligence packages.
|
||||
13
docs/01-library-model.md
Normal file
13
docs/01-library-model.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Library Model
|
||||
|
||||
The library is organised as a UAPF-style process decomposition.
|
||||
|
||||
| Level | Meaning | Folder |
|
||||
|---|---|---|
|
||||
| L0 | Production enterprise context | `levels/L0-production-enterprise` |
|
||||
| L1 | Production domain | `levels/L1-production-domain` |
|
||||
| L2 | Production line operations | `levels/L2-production-line-operations` |
|
||||
| L3 | Operational intelligence loop | `levels/L3-operational-intelligence-loop` |
|
||||
| L4 | Recommendation-to-outcome work task | `levels/L4-recommend-act-record-learn` |
|
||||
|
||||
The library is intended to be viewed in ProcessGit as a process repository, with BPMN/DMN and package viewers enabled through `processgit.viewer.json`.
|
||||
38
docs/02-publishing-to-processgit.md
Normal file
38
docs/02-publishing-to-processgit.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Publishing to ProcessGit
|
||||
|
||||
Target URL:
|
||||
|
||||
```text
|
||||
https://processgit.org/OIPF/generic-industrial-process
|
||||
```
|
||||
|
||||
## Steps
|
||||
|
||||
1. Create organisation `OIPF` in ProcessGit if it does not already exist.
|
||||
2. Create a new processpository named `generic-industrial-process`.
|
||||
3. Set recommended metadata:
|
||||
|
||||
```yaml
|
||||
repo_type: process
|
||||
uapf_level: 0-4
|
||||
status: draft
|
||||
```
|
||||
|
||||
4. Push this repository content:
|
||||
|
||||
```bash
|
||||
git clone https://processgit.org/OIPF/generic-industrial-process.git
|
||||
cd generic-industrial-process
|
||||
# copy files from this package into the repo root
|
||||
git add .
|
||||
git commit -m "Initial OIPF generic industrial process library"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
5. Verify ProcessGit viewers:
|
||||
|
||||
- README markdown view;
|
||||
- BPMN view: `bpmn/generic-industrial-process.bpmn`;
|
||||
- DMN view: `dmn/action-readiness-decision.dmn`;
|
||||
- YAML/package view: `packages/cleaning-optimisation/package.yaml`;
|
||||
- JSON schema view: `resources/schemas/oipf-package.schema.json`.
|
||||
15
docs/03-github-mirror.md
Normal file
15
docs/03-github-mirror.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GitHub Mirror
|
||||
|
||||
Recommended GitHub mirror:
|
||||
|
||||
```text
|
||||
https://github.com/OIPFormat/generic-industrial-process
|
||||
```
|
||||
|
||||
This mirror should be secondary. The canonical process library should live in ProcessGit:
|
||||
|
||||
```text
|
||||
https://processgit.org/OIPF/generic-industrial-process
|
||||
```
|
||||
|
||||
The GitHub mirror can be used for public discoverability, issues, external contributions, and GitHub Actions validation.
|
||||
Reference in New Issue
Block a user