TrainRuns

TrainRun.jl will take a user-defined train and a path as an input for a train run calculation. It can calculate the train run as a time-efficient or energy-efficient operation mode. The results can then be used within the Julia environment.

https://github.com/railtoolkit/trainruns.jl

Science Score: 77.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
✓
Committers with academic emails
2 of 5 committers (40.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.7%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: railtoolkit
License: isc
Language: Julia
Default Branch: main
Homepage: https://railtoolkit.org/projects/trainruns.jl
Size: 648 KB

Statistics

Stars: 8
Watchers: 1
Forks: 2
Open Issues: 25
Releases: 3

Created over 4 years ago · Last pushed almost 2 years ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation

README.md

TrainRuns

About

TrainRuns.jl is a step towards open science and open data in railway engineering. Its modular design offers the possibility to serve as a basis for future optimization and development. TrainRuns.jl is suitable for qualitative calculations to compare different trains, and it is publicly available, and we invite others to collaborate.

Features

TODO

Installation

Use the package manager provided by julia:

julia julia> # use the ] key pkg> add TrainRuns pkg> # use backspace julia> using TrainRuns

The required julia packages are

YAML.jl
JSONSchema.jl
DataFrames.jl

Minimal working example

```julia using TrainRuns

train = Train("train.yaml") # load train from file path = Path("path.yaml") # load running path from file

runtime = trainrun(train, path)[end,:t]

println("The train needs $runtime seconds for the running path.") ```

Further Information

Visit the repository TrainRuns.jl-Tutorials for tutorials in either Jupyther Notebooks or Pluto Notebooks. There you can find, for instance, a basic tutorial.

Please refer to the automated documentation for technical details of the used functions.

Acknowledgement

This work was supervised by South Westphalia University of Applied Sciences and Technical University Braunschweig.

Contributors

_{Max Kannenberg}
🔬 💻 🤔 🚧

_{Martin Scheidt}
🧑‍🏫 ✅ 💻 ⚠️ 🔧 🔬 🔣 🚧 🤔

_{Gregor Wehrle}
💬 🤔 📖 🐛

License

ISC License (ISC)

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

Website: railtoolkit.org
Repositories: 5
Profile: https://github.com/railtoolkit

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: TrainRuns.jl
message: 'If you use this software, please cite it using these metadata.'
type: software
authors:
  - given-names: Max
    family-names: Kannenberg
    affiliation: TU Braunschweig
  - given-names: Martin
    family-names: Scheidt
    email: m.scheidt@tu-bs.de
    orcid: 'https://orcid.org/0000-0002-9384-8945'
    affiliation: TU Braunschweig
identifiers:
  - type: doi
    value: 10.5281/zenodo.6448563
    description: 'Collection of archived snapshots of all versions of the library'
  - type: doi
    value: 10.5281/zenodo.7936770
    description: Current version
url: 'https://www.railtoolkit.org/projects/TrainRuns.jl/'
repository: 'https://github.com/railtoolkit/TrainRuns.jl'
abstract: >-
  TrainRuns.jl is a step towards open science and open data in railway engineering.
  Its modular design offers the possibility to serve as a basis for future
  optimization and development. TrainRuns.jl is suitable for qualitative
  calculations to compare different trains, and it is publicly available, and we
  invite others to collaborate.
keywords:
  - railway
  - running time
  - driving dynamics
  - julia language
license: ISC
version: 1.0.4
date-released: 2023-05-15
preferred-citation:
  authors:
    - family-names: Scheidt
      given-names: Martin
      orcid: https://orcid.org/0000-0002-9384-8945
    - family-names: Kannenberg
      given-names: Max
  doi: 10.2495/cr220221
  title: 'TrainRuns.jl: An Open-Source Tool for Running Time Estimation'
  type: proceedings
  year: 2022
  publisher:
    name: 'WIT Transactions on The Built Environment, Vol 213, WIT Press'

GitHub Events

Total

Issues event: 1
Watch event: 5

Last Year

Issues event: 1
Watch event: 5

Committers

Last synced: over 3 years ago

All Time

Total Commits: 156
Total Committers: 5
Avg Commits per committer: 31.2
Development Distribution Score (DDS): 0.506

Top Committers

Name	Email	Commits
Max Kannenberg	9**g@u**m	77
Martin Scheidt	m**t@t**e	70
github-actions[bot]	4**]@u**m	5
Martin Scheidt	1**0@u**m	3
Max Kannenberg	k**x@f**e	1

Committer Domains (Top 20 + Academic)

fh-swf.de: 1 tu-bs.de: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time

Total issues: 43
Total pull requests: 41
Average time to close issues: 4 months
Average time to close pull requests: about 17 hours
Total issue authors: 4
Total pull request authors: 5
Average comments per issue: 1.7
Average comments per pull request: 0.32
Merged pull requests: 37
Bot issues: 0
Bot pull requests: 9

Past Year

Issues: 9
Pull requests: 16
Average time to close issues: 3 days
Average time to close pull requests: about 18 hours
Issue authors: 3
Pull request authors: 4
Average comments per issue: 4.56
Average comments per pull request: 0.44
Merged pull requests: 15
Bot issues: 0
Bot pull requests: 9

View more stats

Top Authors

Issue Authors

kaat0 (29)
apriljunge (8)
gwehrle (3)
JuliaTagBot (1)

Pull Request Authors

kaat0 (25)
allcontributors[bot] (10)
apriljunge (7)
gwehrle (4)
MaxKannenberg (4)

Top Labels

Issue Labels

Pull Request Labels

refactoring (1)

Packages

Total packages: 1
Total downloads: unknown

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 4

juliahub.com: TrainRuns

Homepage: https://railtoolkit.org/projects/trainruns.jl
Documentation: https://docs.juliahub.com/General/TrainRuns/stable/
License: ISC
Latest release: 1.0.4
published about 3 years ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 9.9%

Dependent packages count: 38.9%

Average: 40.1%

Forks count: 53.5%

Stargazers count: 58.1%

Last synced: 10 months ago

Dependencies

.github/workflows/CI.yml actions

actions/checkout v3 composite
julia-actions/cache v1 composite
julia-actions/julia-buildpkg v1 composite
julia-actions/julia-runtest v1 composite
julia-actions/setup-julia v1 composite

.github/workflows/CompatHelper.yml actions

.github/workflows/JuliaRegister.yml actions

julia-actions/RegisterAction latest composite

.github/workflows/TagBot.yml actions

JuliaRegistries/TagBot v1 composite

.github/workflows/cffvalidation.yml actions

actions/checkout v3 composite
citation-file-format/cffconvert-github-action 2.0.0 composite

.github/workflows/debug.yml actions

actions/checkout v3 composite
lhotari/action-upterm v1 composite

.github/workflows/documentation.yml actions

actions/checkout v3 composite
codecov/codecov-action v3 composite
julia-actions/julia-processcoverage v1 composite
julia-actions/setup-julia v1 composite

.github/workflows/release.yml actions

EndBug/add-and-commit v9 composite
actions/checkout v3 composite
actions/download-artifact v3 composite
actions/upload-artifact v3 composite
cbrgm/mastodon-github-action v1 composite
julia-actions/RegisterAction latest composite
papeloto/action-zip v1.1 composite

.github/workflows/Formatter.yml actions

julia-actions/julia-format v3 composite