Data

Tools

Indexes

Applications

Experiments

Open Source Science

schema

This repo collects the descriptions of the structure and the validation constraints of tools in the railtoolkit in JSON schemas. It is, therefore, an alternative to RailML.

https://github.com/railtoolkit/schema

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

This repo collects the descriptions of the structure and the validation constraints of tools in the railtoolkit in JSON schemas. It is, therefore, an alternative to RailML.

Basic Info
  • Host: GitHub
  • Owner: railtoolkit
  • License: isc
  • Default Branch: main
  • Homepage:
  • Size: 253 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 6
  • Releases: 2
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

RailToolKit Schema

License: ISC DOI Build Status All Contributors

About

This repo collects the descriptions of the structure and the validation constraints of tools in the railtoolkit in JSON schemas. It is, therefore, an alternative to RailML. The JSON schemas enable the validation of YAML files in TrainRun.jl and rolling-stock.

Prerequisite

You will need a validator to validate the schema against data. This package provides a helper script that uses the Ajv JSON schema validator. Ajv rquires to have node installed.

bash $ node --version # test if node is installed

Usage

You will need the schema and some data. The repo contains among others the rolling-stock schema and example data: bash $ git clone https://github.com/railtoolkit/schema.git && cd schema

Install all project dependencies: bash $ npm install

You can now validate if the data follows the schema: bash $ npm run validate:rolling-stock doc/rolling-stock.example.yaml This will return: bash $ doc/rolling-stock.example.yaml valid Or: bash $ npm run validate:running-path doc/running-path.example.yaml This will return: bash $ doc/running-path.example.yaml valid

Documentation

see Rolling-Stock.md and Running-Path.md for information about the used attributes.

Contributors

Martin Scheidt
Martin Scheidt
💻 📖 💡 ⚠️ 🔬		 Gregor Wehrle
Gregor Wehrle
🐛		 JonathanSchoener
JonathanSchoener
🔬

See CONTRIBUTING.md file if you are interested to contribute.

License

Open Source Initiative Approved License logo

Copyright (c) 2022, Martin Scheidt <m.scheidt@tu-bs.de> (ISC License)

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Owner

  • Name: RailToolkit
  • Login: railtoolkit
  • Kind: organization
  • Location: Braunschweig, Germany

Citation (CITATION.cff) 

# YAML 1.2
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
---
cff-version: 1.2.0
title: railtoolkit/schema
message:  If you use this software, please cite it using these metadata.
type: software
authors:
  - given-names: Martin
    family-names: Scheidt
    email: m.scheidt@tu-bs.de
    affiliation: TU Braunschweig
    orcid: 'https://orcid.org/0000-0002-9384-8945'
identifiers:
  - type: doi
    value: 10.5281/zenodo.6462039
    description: >-
      This DOI represents all versions, and will
      always resolve to the latest one.
abstract: >-
  This repo collects the descriptions of the structure and the validation
  constraints of tools in the railtoolkit in JSON schemas. It is, therefore,
  an alternative to <a href="https://www.railml.org/">RailML</a>.
keywords:
  - schema
  - railway
license: ISC

GitHub Events

Total
  • Issues event: 3
  • Delete event: 1
  • Push event: 22
  • Pull request review event: 4
  • Pull request review comment event: 2
  • Pull request event: 1
  • Create event: 1
Last Year
  • Issues event: 3
  • Delete event: 1
  • Push event: 22
  • Pull request review event: 4
  • Pull request review comment event: 2
  • Pull request event: 1
  • Create event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 1
  • Average time to close issues: 10 minutes
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 1
  • Average time to close issues: 10 minutes
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • kaat0 (10)
  • apriljunge (1)
Pull Request Authors
  • allcontributors[bot] (6)
  • apriljunge (2)
  • kaat0 (2)
  • gwehrle (1)
Top Labels
Issue Labels
path (1) rollingstock (1)
Pull Request Labels
path (2)

Dependencies

.github/workflows/cffvalidation.yml actions
  • actions/checkout v4 composite
  • citation-file-format/cffconvert-github-action 2.0.0 composite
.github/workflows/release.yaml actions
  • StuYarrow/publish-release v1 composite
  • actions/checkout v4 composite
  • actions/create-release v1 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • actions/upload-release-asset v1 composite
  • cbrgm/mastodon-github-action v2 composite
  • dawidd6/action-get-tag v1 composite
  • papeloto/action-zip v1.2 composite
.github/workflows/testing.yaml actions
  • actions/checkout v4 composite
package-lock.json npm
  • ajv 8.16.0
  • ajv-cli 5.0.0
  • ajv-formats 3.0.1
  • ansi-styles 6.2.1
  • argparse 1.0.10
  • balanced-match 1.0.2
  • brace-expansion 2.0.1
  • brace-expansion 1.1.11
  • concat-map 0.0.1
  • cross-spawn 7.0.3
  • esprima 4.0.1
  • fast-deep-equal 2.0.1
  • fast-deep-equal 3.1.3
  • fast-json-patch 2.2.1
  • fs.realpath 1.0.0
  • glob 7.2.3
  • inflight 1.0.6
  • inherits 2.0.4
  • isexe 2.0.0
  • js-yaml 3.14.1
  • json-parse-even-better-errors 3.0.2
  • json-schema-migrate 2.0.0
  • json-schema-traverse 1.0.0
  • json5 2.2.3
  • memorystream 0.3.1
  • minimatch 3.1.2
  • minimatch 9.0.5
  • minimist 1.2.8
  • npm-normalize-package-bin 3.0.1
  • npm-run-all2 6.2.2
  • once 1.4.0
  • path-is-absolute 1.0.1
  • path-key 3.1.1
  • pidtree 0.6.0
  • punycode 2.3.1
  • read-package-json-fast 3.0.2
  • require-from-string 2.0.2
  • shebang-command 2.0.0
  • shebang-regex 3.0.0
  • shell-quote 1.8.1
  • sprintf-js 1.0.3
  • uri-js 4.4.1
  • which 2.0.2
  • wrappy 1.0.2
package.json npm
  • ajv-cli ^5.0.0
  • ajv-formats ^3.0.1
  • npm-run-all2 ^6.2.2