Providing more meta information for potential collaborators

development
Martin Scheidt 2022-04-19 20:12:40 +02:00
parent 71ff668cc3
commit 91d59b9182
6 changed files with 142 additions and 7 deletions

View File

@ -9,7 +9,8 @@ Categories: Added, Changed, Deprecated, Removed, Fixed, and Security.
## [Unreleased] ## [Unreleased]
## Version [0.8]
## Version [0.8] 2022-01-20
### Changed ### Changed
@ -22,8 +23,7 @@ Refactor the modular structure:
* Rename the module Preparation to Characteristics * Rename the module Preparation to Characteristics
## Version [0.7] ## Version [0.7] 2022-01-14
### Changed ### Changed
@ -36,7 +36,7 @@ Refactor all mutable structs as a Dictionaries:
* Rename some variables * Rename some variables
## Version [0.6.2] ## Version [0.6.2] 2021-12-17
### Added ### Added
@ -74,22 +74,26 @@ Refactor some of the mutable structs from types.jl as Dictionaries
* Create a Dictionary for the whole moving section in Preperation.jl and a function for copying the moving section in OperationModes.jl * Create a Dictionary for the whole moving section in Preperation.jl and a function for copying the moving section in OperationModes.jl
* Change the type of existing Dictionary keys from String to Symbol * Change the type of existing Dictionary keys from String to Symbol
## Version [0.5.3] ## Version [0.5.3]
### Changed ### Changed
Rename variables in every .jl an .yaml file Rename variables in every .jl an .yaml file
## Version [0.5.2] ## Version [0.5.2]
Merge fixing branches Merge fixing branches
## Version [0.5.1] ## Version [0.5.1]
### Changed ### Changed
Rename the real world path file Rename the real world path file
## Version [0.5] ## Version [0.5]
### Changed ### Changed
@ -110,7 +114,6 @@ Rename waypoints
## Version [0.4] ## Version [0.4]
### Changed ### Changed
Refactor and fix modules EnergySaving, OperationModes and MovingPhases Refactor and fix modules EnergySaving, OperationModes and MovingPhases
@ -120,7 +123,6 @@ Refactor and fix modules EnergySaving, OperationModes and MovingPhases
## Version [0.3] ## Version [0.3]
### Changed ### Changed
Refactor module MovingPhases Refactor module MovingPhases
@ -135,7 +137,7 @@ Refactor module MovingPhases
Modules and variables were renamed. Modules and variables were renamed.
## Version [0.1] ## Version [0.1] 2021-02-19
Proof of concept and master thesis submission. Proof of concept and master thesis submission.

40
CITATION.cff Normal file
View File

@ -0,0 +1,40 @@
# 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: TrainRun.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.6448564
description: Current version
url: 'https://www.railtoolkit.org/projects/TrainRun.jl/'
repository: 'https://github.com/railtoolkit/TrainRun.jl'
abstract: >-
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.
keywords:
- railway
- running time
- driving dynamics
- julia language
license: ISC
version: v0.8
date-released: 2022-01-20

74
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,74 @@
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

11
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,11 @@
# Contributing
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
Please note we have a code of conduct, please follow it in all your interactions with the project.
# Pull Request Process
* add your changes to the CHANGELOG.md under [Unreleased]
* TODO!

View File

@ -1,5 +1,13 @@
# TrainRun # TrainRun
[![License: ISC](https://img.shields.io/badge/license-ISC-green.svg)](https://opensource.org/licenses/ISC)
------------
# 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 # Installation

View File