confirmed, superuser, Administrators
539
edits
Changes
Jump to navigation
Jump to search
mLine 1:
Line 1: − + Line 54:
Line 54: − +
no edit summary
In [[Railway Operation Simulator]] (ROS) ''Metadata'' files are files included within a simulation as a means of providing further information and properties not retrievable from the railway and timetable files. Inclusion of such a file was first proposed in 2021 by the ROS Development Team as an optional extension for projects and the decision made to use [https://toml.io/en/ TOML] as the syntax being both easily human and machine readable. The file is not strictly required but recommended, a starting version of this file is automatically generated via GitHub Actions when using the [https://github.com/Railway-Op-Sim/UN-Template Template Repository] provided by the [[ROS GitHub Organisation]]. During installation of a simulation Metadata files should be placed within the <code>Metadata</code> directory in the <code>Railway</code> directory of the user's ROS installation.
In [[Railway Operation Simulator]] (RailOS) ''Metadata'' files are files included within a simulation as a means of providing further information and properties not retrievable from the railway and timetable files. Inclusion of such a file was first proposed in 2021 by the ROS Development Team as an optional extension for projects and the decision made to use [https://toml.io/en/ TOML] as the syntax being both easily human and machine readable. The file is not strictly required but recommended, a starting version of this file is automatically generated via GitHub Actions when using the [https://github.com/Railway-Op-Sim/UN-Template Template Repository] provided by the [[Developer_GitHub_Organisation|Railway-Op-Sim GitHub Organisation]]. During installation of a simulation Metadata files should be placed within the <code>Metadata</code> directory in the <code>Railway</code> directory of the user's RailOS installation.
== Schema ==
== Schema ==
== Software Usage ==
== Software Usage ==
Metadata files are used in some ROS utilities including [[ROSLauncher]] and [[ROSPkgManager]]. These make use of the [[rostools]] libraries which contains variants for parsing the TOML data in Python, C++ and Java.
Metadata files are used in some ROS utilities including [[ROSLauncher]] and [[RailOSPkgManager]]. These make use of the [[rostools]] libraries which contains variants for parsing the TOML data in Python, C++ and Java.