max
/
TrainRun.jl
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated license and usage

development
Martin Scheidt 2022-05-04 17:25:08 +02:00
parent 18ec0e5c54
commit 0b84ac0d9a
2 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,6 +1,6 @@
ISC License (ISC) ISC License (ISC)
Copyright 2021 Max Kannenberg Copyright 2022 Max Kannenberg, Martin scheidt
Permission to use, copy, modify, and/or distribute this software for any purpose 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 with or without fee is hereby granted, provided that the above copyright notice

18
README.md
View File

@ -1,7 +1,6 @@
# TrainRuns # TrainRuns
[![License: ISC](https://img.shields.io/badge/license-ISC-green.svg)](https://opensource.org/licenses/ISC) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6448563.svg)](https://doi.org/10.5281/zenodo.6448563) [![License: ISC](https://img.shields.io/badge/license-ISC-green.svg)](https://opensource.org/licenses/ISC) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6448563.svg)](https://doi.org/10.5281/zenodo.6448563) [![Build Status](https://github.com/railtoolkit/TrainRuns.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/railtoolkit/TrainRuns.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Build Status](https://github.com/railtoolkit/TrainRuns.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/railtoolkit/TrainRuns.jl/actions/workflows/CI.yml?query=branch%3Amain)
------------ ------------
@ -13,10 +12,17 @@ TrainRuns.jl is a step towards open science and open data in railway engineering
# Installation # Installation
Use the package manager provided by julia:
```julia
julia> # use the ] key
(@v1.x) pkg> add TrainRuns
(@v1.x) pkg> # use backspace
julia> using TrainRuns
```
The required julia packages are The required julia packages are
- YAML.jl - YAML.jl
- JSONSchema.jl - JSONSchema.jl
- Dates.jl
- DataFrames.jl - DataFrames.jl
- CSV.jl - CSV.jl
@ -25,7 +31,7 @@ The required julia packages are
# Minimal working example # Minimal working example
```julia ```julia
import TrainRuns using TrainRuns
train = Train("test/data/trains/freight.yaml") train = Train("test/data/trains/freight.yaml")
path = Path("test/data/paths/const.yaml") path = Path("test/data/paths/const.yaml")
@ -45,11 +51,11 @@ This work was supervised by South Westphalia University of Applied Sciences and
# License # License
[![Open Source Initiative Approved License logo](https://opensource.org/files/OSIApproved_100X125.png "Open Source Initiative Approved License logo")](https://opensource.org) [![Open Source Initiative Approved License logo](https://opensource.org/files/OSIApproved_100X125.png "Open Source Initiative Approved License logo")](https://opensource.org)
ISC License (ISC) ISC License (ISC)
Copyright 2021 Max Kannenberg 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. 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.