Dev:Downloading and using railML: Difference between revisions

From railML 3 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
Line 7: Line 7:
# Consent to the {{site|https://www.railml.org/en/user/licence.html|licence terms}}. railML<sup>®</sup> is licensed dually with either a restricted {{external|https://creativecommons.org/licenses/by-nc-nd/3.0/de|CC-BY-NC-ND licence}} or a commercial licence.
# Consent to the {{site|https://www.railml.org/en/user/licence.html|licence terms}}. railML<sup>®</sup> is licensed dually with either a restricted {{external|https://creativecommons.org/licenses/by-nc-nd/3.0/de|CC-BY-NC-ND licence}} or a commercial licence.
# Download the zip file with the current version of the railML<sup>®</sup> schema files.
# Download the zip file with the current version of the railML<sup>®</sup> schema files.
For obtaining the developers' version (not recommended for beginners and for applications afield), please contact the {{site|https://www.railml.org/en/subschemas railML.org|coordinators}}.
For obtaining the developers' version (not recommended for beginners and for applications afield), please contact the {{coordinators|{{rml|link=no}} coordinators}}.


==Using railML<sup>®</sup>==
==Using railML<sup>®</sup>==

Revision as of 17:05, 24 January 2025

Downloading and using railML®

This Guideline is intended to help you through the first steps in downloading and using railML®.

Download railML®

  1. If you are not yet registered to https://railml.org (link to the railML® website), please register (link to the railML® website) first. The registration is for free. We need your registration to keep track of the use of railML®, as its advantages rely on an undisturbed data exchange. Read our data privacy statement (Link zur railML®-Website) for the details.
  2. (Log into railML.org (link to the railML® website) and) go to our download page (link to the railML® website)
  3. Consent to the licence terms (link to the railML® website). railML® is licensed dually with either a restricted CC-BY-NC-ND licence (external link) or a commercial licence.
  4. Download the zip file with the current version of the railML® schema files.

For obtaining the developers' version (not recommended for beginners and for applications afield), please contact the railML® coordinators (link to the railML® website).

Using railML®

The community will help you getting started with railML®. Feel free to use the following support tracks:

  • The railML®-Wiki is the core mean of documentation. A collection of Users and Developers Guides (e.g. how to contribute to this wiki) can be found here.
  • If our wiki leaves any questions unanswered, join our Forum (link to the railML® website), where railML® developers and users can exchange their experiences and discuss problems or enhancements.
  • Meet other Users, the developers and the coordinators on a railML.org conference. Conferences are ordinarily held twice a year. Please, watch our calendar (link to the railML® website) for obtaining information about the next event.
  • Certify your interface. While you can use railML® in island solutions e.g. for exercise, in most cases productive use aims at and depends on exchanging data with other units (another application; another division within your company; another corporation). As to grant for a smooth operation, the licence demands you to certify your interface if you use it productively (thus afield, exchanging data with others). The procedure is sketched here (link to the railML® website).