You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/OpenRail-onboarding.md
+16-11Lines changed: 16 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,8 @@ TP-Lib is valuable because:
19
19
- It provides a full pipeline: GNSS input → candidate selection → probabilistic HMM path calculation → network projection → CSV/GeoJSON output.
20
20
- It ships a browser-based interactive path review and editing tool (`tp-webapp`) so operators can correct the calculated path before final projection.
21
21
- It exposes a CLI (`tp-cli`) for operational use, a Python API (`tp-lib` on PyPI) for integration in data science workflows and a .NET API (`TpLib` on NuGet, install via `dotnet add package TpLib`).
22
+
- It integrates with the EU register of railway infrastructure (RINF) to download the micro network topology if the user doesn't have this at his disposal
23
+
- It is build with common terminology as internationally recognised by models such as RTM, RSM, EULYNX, railML, ERA ontology, ...
22
24
- It is thoroughly tested with 460 tests (unit, integration, contract, CLI, and doctests).
23
25
24
26
## Who are the maintainers of the project (these will be the primary contacts for the OpenRail Association)?
@@ -52,58 +54,61 @@ All third-party dependencies use permissive licenses compatible with Apache 2.0:
-**BSD-2-Clause**: Leaflet.js (JavaScript, bundled in the web application)
57
+
-**CDLA-Permissive-2.0**: webpki-root for CA
55
58
56
59
No copyleft (GPL/LGPL) dependencies are used.
57
60
58
-
A GitHub action has been configured to generate an SBOM and check the licenses as suggested by Openrail's onboarding manual.
61
+
A [GitHub action](https://github.com/Matdata-eu/tp-lib/actions/workflows/sbom.yml) has been configured to generate an SBOM and check the licenses as suggested by Openrail's onboarding manual.
59
62
60
63
## Are any trademarks associated with the project?
61
64
62
65
No
63
66
64
67
## Does the project have a web site? Where is it? Are you ok with moving it to be hosted by the OpenRail Association?
65
68
66
-
The project has a documentation site hosted on GitHub Pages at https://matdata-eu.github.io/tp-lib/ specifically about the Rust. This will need to be moved when the Github repository is moved.
69
+
The project has a documentation site hosted on GitHub Pages at https://matdata-eu.github.io/tp-lib/ specifically about the Rust. This will need to be moved when the Github repository is moved. Other documentation is available as README.md file in the repository root and it's individual packages (such as the python, .net, and webapp dependencies)
67
70
68
71
## What are the communication channels the project uses (such as mailing lists, Slack, IRC, etc.)?
69
72
70
-
Communication currently happens through GitHub: Issues for bug reports and feature requests, and Pull Requests for code contributions. There are no mailing lists, Slack workspaces, or other channels at this time.
73
+
Communication happens through GitHub: Issues for bug reports and feature requests, and Pull Requests for code contributions. There are no mailing lists, Slack workspaces, or other channels at this time.
71
74
72
75
## What is the project's leadership team and decision-making process?
73
76
74
-
The project is led by its Maintainers, who are responsible for organizing development activities and determining consensus. Decisions are made through a consensus-based process, with appeals handled first by the Maintainers and then, if needed, by the Technical Committee. See the [governance file](../GOVERNANCE.md).
77
+
The project is led by its Maintainers, who are responsible for organizing development activities and determining consensus. Decisions are made through a consensus-based process, with appeals handled first by the Maintainers and then, if needed, by the Technical Committee. See the [governance file](https://github.com/Matdata-eu/tp-lib/blob/main/GOVERNANCE.md).
75
78
76
79
## How is it decided if and when a pull request is merged?
77
80
78
-
Pull requests are merged based on Maintainer consensus rather than a fixed voting rule. Maintainers consider contributor input, support, and objections in good faith, and are expected to document the evidence for consensus behind their decisions. See the [governance file](../GOVERNANCE.md).
81
+
Pull requests are merged based on Maintainer consensus rather than a fixed voting rule. Maintainers consider contributor input, support, and objections in good faith, and are expected to document the evidence for consensus behind their decisions. See the [governance file](https://github.com/Matdata-eu/tp-lib/blob/main/GOVERNANCE.md).
79
82
80
83
## How can someone become a committer or a maintainer to/of the project?
81
84
82
-
Anyone can contribute to the project, and contributors are recognized as people who have made contributions. Maintainers are added or removed with the approval of the current Maintainers, and maintainers formally accept the project policies by adding their name to the maintainers file. See the [governance file](../GOVERNANCE.md).
85
+
Anyone can contribute to the project, and contributors are recognized as people who have made contributions. Maintainers are added or removed with the approval of the current Maintainers, and maintainers formally accept the project policies by adding their name to the maintainers file. See the [governance file](https://github.com/Matdata-eu/tp-lib/blob/main/GOVERNANCE.md).
83
86
84
87
## How is development of the project planned and organized? Is this transparent to the public?
85
88
86
-
Development is organized openly by the Maintainers under written public procedures. The governance model emphasizes open participation, consideration of contributor feedback and objections, balance across stakeholders, and publicly available process documents. See the [governance file](../GOVERNANCE.md).
89
+
Development is organized openly by the Maintainers under written public procedures. The governance model emphasizes open participation, consideration of contributor feedback and objections, balance across stakeholders, and publicly available process documents. See the [governance file](https://github.com/Matdata-eu/tp-lib/blob/main/GOVERNANCE.md).
87
90
88
91
## What is the project's roadmap?
89
92
90
-
After the project refactoring and extensive testing, no further development is planned at this time.
93
+
After the project refactoring and extensive testing, no further development is planned at this time. Depending on the community, two principle points could be addressed:
94
+
- Longitudal distribution of the GNSS projected points based on wheel sensor (odometry) or timestamp/speed
95
+
- Input/output to RSM-DX
91
96
92
97
## What other organizations in the world should be interested in this project?
93
98
94
-
All organisations that use railway vehicles with GNSS traces that need to be mapped on the network. But the project can also be used as a guideline for organisations that want to post processes location measurements for other domains that include topology and navigability.
99
+
All organisations that use railway vehicles with GNSS traces that need to be mapped on the network offboard. But the project can also be used as a guideline for organisations that want to post processes location measurements for other domains that include topology and navigability.
95
100
96
101
## Why would this project be a good candidate for inclusion in the OpenRail Association?
97
102
98
-
Because all infra managers do this and should better do it together.
103
+
Because all railway infrastructure managers do this and should better do it together.
99
104
100
105
## Are there competing products or projects? If there are, please explain how the proposed projects differentiates.
101
106
102
107
Not that we know of.
103
108
104
109
## What standards does the project implement or rely on? How are they related to other existing standards?
105
110
106
-
Topology and navigability is also defined by several other railway related standards. But they are very loosely related. Examples include: RailTopoModel, RailSystemModel, railML, RINF.
111
+
Topology and navigability is also defined by several other railway related standards. But they are very loosely related. Examples include: RailTopoModel, RailSystemModel, railML, ERA ontology.
107
112
108
113
## What is the tech stack of the project? Name the major programming languages and frameworks which are used.
0 commit comments