Skip to content

Commit f53a511

Browse files
committed
Improved pages and organization
1 parent 05da487 commit f53a511

2 files changed

Lines changed: 32 additions & 25 deletions

File tree

docs/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@ hide:
66

77
# Beamline Framework
88

9-
Beamline is a Java framework designed to facilitate the prototyping and the development of ***streaming process mining*** algorithms.
9+
Beamline is a framework designed to facilitate the prototyping and the development of ***streaming process mining*** algorithms.
1010

11-
The framework is designed on top of [Apache Flink](https://flink.apache.org/) which makes it suitable for extremely efficient computation due to the distributed and stateful nature of its components. The Beamline consists of both algorithms as well as data structures, sources, and sinks to facilitate the development of process mining applications. While redefining the concept of *event*, Beamline tries to maintain compatibility with OpenXES and the IEEE XES standard.
11+
The framework comprises two libraries: **Beamline** (Java) and **pyBeamline** (Python).
1212

13+
Beamline, the Java library, is designed on top of [Apache Flink](https://flink.apache.org/) which makes it suitable for extremely efficient computation due to the distributed and stateful nature of its components. The Beamline consists of both algorithms as well as data structures, sources, and sinks to facilitate the development of process mining applications. While redefining the concept of *event*, Beamline tries to maintain compatibility with OpenXES and the IEEE XES standard.
14+
15+
pyBeamline is built on [ReactiveX](https://reactivex.io/) and its Python implementation, RxPY - a library for composing asynchronous, event-driven programs using observable sequences and pipable query operators. pyBeamline is suitable for prototyping algorithm very quickly, without necessarily bothering with performance aspects. It also simplifies collaboration by, for example, leveraging online notebook services (like Google Colab).
1316

1417

1518
## Streaming process mining
@@ -35,7 +38,7 @@ flow Discovery from Event Streams. In Proc. of IEEE WCCI-CEC, 2014.</span></p></
3538

3639
## Beamline
3740

38-
Beamline is a Java framework meant to simplify the research and the development of streaming process mining, by providing a set of tools that can lift researchers from the burden of setting up streams and running experiments.
41+
Beamline is a framework meant to simplify the research and the development of streaming process mining, by providing a set of tools that can lift researchers from the burden of setting up streams and running experiments.
3942

4043
!!! note "On the name Beamline"
4144
The term *Beamline* is borrowed from [high energy physics](https://en.wikipedia.org/wiki/Beamline), where it indicates the physical structure used to define experiments, i.e., where the accelerated particles travel. In the streaming process mining case, Beamline is used to set up experiments where process mining events are processed and consumed.

mkdocs.yml

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,37 @@ edit_uri: ""
33

44
nav:
55
- Home: index.md
6-
- Getting started: getting-started.md
7-
- Implemented techniques:
8-
- Introduction: implemented-techniques/index.md
9-
- Control-flow discovery:
10-
- Trivial Miner: implemented-techniques/discovery-trivial.md
11-
- Heuristics Miner: implemented-techniques/discovery-heuristics-miner.md
12-
- Declare Miner: implemented-techniques/discovery-declare.md
13-
- DCR Miner: implemented-techniques/discovery-dcr.md
14-
- Soft Conformance Model Miner: implemented-techniques/discovery-soft.md
15-
- Split Miner: implemented-techniques/discovery-splitminer.md
16-
- Conformance checking:
17-
- Behavioural Patterns: implemented-techniques/conformance-behavioural-patterns.md
18-
- Soft Conformance: implemented-techniques/conformance-soft.md
19-
- Simulation:
20-
- Simulation with PLG: implemented-techniques/simulation-plg.md
6+
- Beamline:
7+
- Getting started: getting-started.md
8+
- Implemented techniques:
9+
- Introduction: implemented-techniques/index.md
10+
- Control-flow discovery:
11+
- Trivial Miner: implemented-techniques/discovery-trivial.md
12+
- Heuristics Miner: implemented-techniques/discovery-heuristics-miner.md
13+
- Declare Miner: implemented-techniques/discovery-declare.md
14+
- DCR Miner: implemented-techniques/discovery-dcr.md
15+
- Soft Conformance Model Miner: implemented-techniques/discovery-soft.md
16+
- Split Miner: implemented-techniques/discovery-splitminer.md
17+
- Conformance checking:
18+
- Behavioural Patterns: implemented-techniques/conformance-behavioural-patterns.md
19+
- Soft Conformance: implemented-techniques/conformance-soft.md
20+
- Simulation:
21+
- Simulation with PLG: implemented-techniques/simulation-plg.md
22+
- pyBeamline: pybeamline.md
2123
- Additional libraries:
2224
- Introduction: additional-libraries.md
2325
- MQTT-XES: mqtt-xes.md
2426
- Simple PNML: simple-pnml.md
25-
- pyBeamline: pybeamline.md
2627
- Examples:
2728
- Introduction: examples/index.md
28-
- pyBeamline full cycle: examples/pybeamline-full-cicle.md
29-
- Raw data as input (non-process mining ready): examples/no-process-mining-as-input.md
30-
- Monitoring active windows (for Windows systems): examples/monitoring-windows.md
31-
- Speech recognition: examples/speech-recognition.md
32-
- Wikipedia edits: examples/wikipedia-edits.md
33-
- OpenSky monitoring: examples/open-sky-monitoring.md
29+
- Beamline:
30+
- Raw data as input (non-process mining ready): examples/no-process-mining-as-input.md
31+
- Monitoring active windows (for Windows systems): examples/monitoring-windows.md
32+
- Speech recognition: examples/speech-recognition.md
33+
- Wikipedia edits: examples/wikipedia-edits.md
34+
- OpenSky monitoring: examples/open-sky-monitoring.md
35+
- pyBeamline:
36+
- pyBeamline full cycle: examples/pybeamline-full-cicle.md
3437
- About: about.md
3538

3639
theme:
@@ -42,6 +45,7 @@ theme:
4245
features:
4346
- navigation.tabs
4447
- navigation.tabs.sticky
48+
- navigation.expand
4549
- toc.integrate
4650

4751
repo_url: https://github.com/beamline/framework

0 commit comments

Comments
 (0)