Go to file

Martin Scheidt 9b00bb8b12 improved description fro Julia environment		2022-04-30 12:37:22 +02:00
.github/workflows	added docs and GitHub actions from Julia template	2022-04-28 17:23:23 +02:00
docs	added docs and GitHub actions from Julia template	2022-04-28 17:23:23 +02:00
src	correct lower/upper case pickup	2022-04-28 18:34:18 +02:00
test	new type Settings as struct	2022-04-28 17:02:40 +02:00
.gitignore	master thesis submission	2021-10-13 16:49:42 +02:00
CHANGELOG.md	changed upper case to lower case	2022-04-28 17:29:24 +02:00
CITATION.cff	Providing more meta information for potential collaborators	2022-04-19 20:12:40 +02:00
CODE_OF_CONDUCT.md	Providing more meta information for potential collaborators	2022-04-19 20:12:40 +02:00
CONTRIBUTING.md	improved description fro Julia environment	2022-04-30 12:37:22 +02:00
LICENSE	master thesis submission	2021-10-13 16:49:42 +02:00
Project.toml	new type Settings as struct	2022-04-28 17:02:40 +02:00
README.md	new type Settings as struct	2022-04-28 17:02:40 +02:00

README.md

TrainRun

About

TrainRun.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. TrainRun.jl is suitable for qualitative calculations to compare different trains, and it is publicly available, and we invite others to collaborate.

Installation

The required julia packages are

YAML.jl
Dates.jl
DataFrames.jl
CSV.jl
Plots.jl

Review the settings.yaml file for your appropriate settings.

Minimal working example

include("../src/TrainRun.jl")
using .TrainRun

train_directory =  "data/trains/train_freight_V90withOreConsist.yaml"
running_path_directory = "data/paths/path_1_10km_nConst_vConst.yaml"
settings_directory = "data/settings.yaml"
(train, running_path, settings) = importYamlFiles(train_directory, running_path_directory, setting_directory)

train_run = trainRun(train, running_path, settings)

Acknowledgement

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

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.