Merge pull request #19 from railtoolkit/development

Development

.github/workflows/release.yml

@@ -61,16 +61,6 @@ jobs:
           path: .github/zenodo/metadata.json
           if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
 
-  register:
-    needs: create_package
-    name: "publish in JuliaRegistries"
-    runs-on: ubuntu-latest
-    steps:
-      # 1. register new release at JuliaRegistries
-      - uses: julia-actions/RegisterAction@latest
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-
   publish_github:
     needs: create_package
     name: "publish on github"
@@ -141,7 +131,7 @@ jobs:
           echo "::set-output name=doi::$(zenodraft deposition show prereserved $ID)"
 
   update_citation:
-    needs: [create_package, register, publish_zenodo]
+    needs: publish_zenodo
     name: "updating CITATION.cff"
     runs-on: ubuntu-latest
     steps:
@@ -175,8 +165,18 @@ jobs:
           commit_user_name: railtoolkit
           commit_user_email: railtoolkit@ownx.net
 
+  register:
+    needs: update_citation
+    name: "publish in JuliaRegistries"
+    runs-on: ubuntu-latest
+    steps:
+      # 1. register new release at JuliaRegistries
+      - uses: julia-actions/RegisterAction@latest
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
   publish_twitter:
-    needs: [publish_zenodo]
+    needs: publish_zenodo
     name: "tweet about it"
     runs-on: ubuntu-latest
     steps:

CONTRIBUTING.md

@@ -85,3 +85,28 @@ TODO
 * If a PR is not finished yet and should not be reviewed yet then it should be opened as DRAFT 
   (in this way maintainers will know that they can ignore such PR until it is made non-draft or the author
   asks for a review).
+
+## Contribution Ideas
+
+Models for:
+* Breakaway (currently simple like acceleration)
+* braking (currently constant braking with a certain value)
+* inhomogeneous mass band (consider non-uniform mass distribution (cf. Wende, 2003 p. 96f.))
+
+More exact calculation of resistances for:
+* the track (e.g. including curves, switches, tunnels) 
+* for the train (e.g. there are vehicle resistance equations especially for high-speed trains, which are not yet considered in the tool (cf. Wende, 2003 p. 152 f.))
+
+Input/calculation of tractive force (currently only tractive force-speed pairs. This could be extended to include tractive force functions that apply to specific velocity ranges (cf. Brünger, et al., 2014 p. 69).
+
+Calculation of energy, cf. (Wende, 2003 p. 324).
+
+switching between different step variables in one train run or implementation of variable step size (currently it is necessary to choose between s, t and v and to specify a step size that becomes smaller at intersections, but is otherwise constant)
+
+Driver behaviour, in order to be able to determine the driving behavior of the vehicles more realistically.
+
+Energy-saving driving.
+
+good plots would be nice
+
+Pluto notebook show case

src/TrainRuns.jl

@@ -40,7 +40,7 @@ The running time will be return in seconds.
 
 # Examples
 ```julia-repl
-julia> trainrun(train, path)
+julia> trainrun(train, path)[end,:t]
 xxx.xx # in seconds
 ```
 """

src/constructors.jl

@@ -14,19 +14,19 @@ The function Settings() will create a set of settings for the train run calculat
 # Example
 ```
 julia> my_settings = Settings() # will generate default settings
-Settings(mass_point, :distance, 20, 3, running_time, :dataframe)
+# massModel, stepVariable, stepSize, approxLevel, outputDetail, outputFormat
+Settings(:mass_point, :distance, 20, 3, :running_time, :dataframe)
 ```
 """
-function Settings(file="DEFAULT")
-
-    ## default values
-    massModel    = :mass_point
-    stepVariable = :distance
-    stepSize     = 20
-    approxLevel  = 3
-    outputDetail = :running_time
-    outputFormat = :dataframe
-
+function Settings(
+            file         = "DEFAULT";
+            massModel::Symbol    = :mass_point,
+            stepVariable::Symbol = :distance,
+            stepSize::Number     = 20,
+            approxLevel::Number  = 3,
+            outputDetail::Symbol = :running_time,
+            outputFormat::Symbol = :dataframe
+        )
     ## load from file
     if file != "DEFAULT"