max
/
TrainRun.jl
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
179 Commits
2 Branches
16 Tags
1.8 MiB
Julia 100%
 
Go to file
Martin Scheidt 9e51a535e1 included published paper 2023-02-21 09:42:56 +01:00
.github fix documentations issues 2022-12-31 00:24:46 +01:00
docs fix documentations issues 2022-12-31 00:24:46 +01:00
src fixed schema validation including test 2022-12-19 21:41:30 +01:00
test fixed schema validation including test 2022-12-19 21:41:30 +01:00
.gitignore master thesis submission 2021-10-13 16:49:42 +02:00
CHANGELOG.md Updated to version 1.0.3 2022-12-30 20:46:25 +01:00
CITATION.cff included published paper 2023-02-21 09:42:56 +01:00
CODE_OF_CONDUCT.md added mail address 2022-05-06 00:05:48 +02:00
CONTRIBUTING.md Updated contribution ideas 2022-12-19 13:44:41 +01:00
LICENSE Update LICENSE 2022-05-17 11:16:45 +02:00
Project.toml Set version to 1.0.3 2022-12-30 20:05:09 +00:00
README.md updated README.md with tutorials and documentation 2022-12-21 15:43:23 +01:00

README.md

TrainRuns

License: ISC DOI Build Status

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.

Installation

Use the package manager provided by julia:

julia> # use the ] key
(@v1.x) pkg> add TrainRuns
(@v1.x) pkg> # use backspace
julia> using TrainRuns

The required julia packages are

  • YAML.jl
  • JSONSchema.jl
  • DataFrames.jl

Minimal working example

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.

License

Open Source Initiative Approved License logo

ISC License (ISC)

Copyright 2022 Max Kannenberg, Martin Scheidt

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.