tikz-trackschematic

This TikZ library is a toolbox of symbols geared primarily towards creating track schematic for either research or educational purposes. It provides a TikZ frontend to some of the symbols which may be needed to describe situations and layouts in railway operation.

https://github.com/railtoolkit/tikz-trackschematic

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary

Keywords

latex tikz
Last synced: 9 months ago · JSON representation ·

Repository

This TikZ library is a toolbox of symbols geared primarily towards creating track schematic for either research or educational purposes. It provides a TikZ frontend to some of the symbols which may be needed to describe situations and layouts in railway operation.

Basic Info
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 1
  • Open Issues: 14
  • Releases: 8
Topics
latex tikz
Created over 6 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

TikZ-trackschematic

License: ISC DOI CI test


Installation

The tikz library is contained in the files: * tikz-trackschematic.sty * tikzlibrarytrackschematic.code.tex, * tikzlibrarytrackschematic.topology.code.tex, * tikzlibrarytrackschematic.trafficcontrol.code.tex, * tikzlibrarytrackschematic.vehicles.code.tex, * tikzlibrarytrackschematic.constructions.code.tex, * tikzlibrarytrackschematic.symbology.code.tex, * tikzlibrarytrackschematic.electrics.code.tex, and * tikzlibrarytrackschematic.measures.code.tex.

These files should be copied wherever TeX can find it, for example in your $TEXMF folder.

Alternatively, the tikz library is provided by CTAN as "tikz-trackschematic" and is thus part of the TeX Live distribution or can be installed via MiKTeX.

The library can then be loaded through the command TeX \usepackage{tikz-trackschematic} in any LaTeX file.

The library can also be used in Overleaf.


Minimal working example

```TeX \documentclass{standalone} % LaTeX \usepackage{tikz-trackschematic} % loading the library

\begin{document} \begin{tikzpicture}

% TikZ command: specify coordinates
\coordinate (A)   at (0,0);
\coordinate (B)   at (6,0);
\coordinate (T)   at (5,0);

% draw a track
\maintrack (A) -- (B);

% place a train on the track
\train[forward] at (T) label ();

\end{tikzpicture} \end{document} ``` results in:

train on a track


Symbology and meaning

Please consult the symbology table for further information regarding meaning of the symbols.


Roadmap

  • rethink syntax
  • provide option for internationalziation (i18n)
  • rewrite library with better coding skills
  • include support for glossaries package

Acknowledgement

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No. 826347.


License

Open Source Initiative Approved License logo

Copyright (c) 2018 - 2022, Martin Scheidt <m.scheidt@tu-bs.de> (ISC License)

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.

Owner

  • Name: RailToolkit
  • Login: railtoolkit
  • Kind: organization
  • Location: Braunschweig, Germany

Citation (CITATION.cff)

# 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: tikz-trackschematic
message: 'If you use this software, please cite both the proceedings from preferred-citation and the software itself.'
type: software
authors:
  - 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.5539844
    description: 'Collection of archived snapshots of all versions of the library'
  - type: doi
    value: 10.5281/zenodo.6607601
    description: Current version
url: https://www.railtoolkit.org/projects/tikz-trackschematic
repository: https://github.com/railtoolkit/tikz-trackschematic
repository-code: https://repository.ivev.bau.tu-bs.de/martin/tikz-trackschematic
repository-artifact: https://ctan.org/pkg/tikz-trackschematic
abstract: >-
  'A TikZ library for creating track diagrams in
  railways. The tikz-trackschematic library is a
  toolbox of symbols geared primarily towards
  creating track schematic for either research or
  educational purposes. It provides a TikZ frontend
  to some of the symbols which maybe needed to
  describe situations and layouts in railway
  operation.'
keywords:
  - tex
  - symbology
  - railway
  - railroad
  - operational scenarios
  - graphical description
license: ISC
version: v0.7.1
date-released: 2022-06-02
preferred-citation:
  authors:
    - family-names: Scheidt
      given-names: Martin
      orcid: https://orcid.org/0000-0002-9384-8945
    - family-names: Pachl
      given-names: Jörn
  doi: 10.24355/dbbs.084-202204140847-0
  title: 'TikZ-trackschematic library: a symbology towards a universal graphical description for operational scenarios in railway research'
  type: proceedings
  year: 2022
  publisher:
    name: "RailBeijing 2021 - the 9th International Conference on Railway Operations Modelling and Analysis (ICROMA). 3.-7. November , 2021"

GitHub Events

Total
  • Issues event: 4
  • Watch event: 3
  • Issue comment event: 1
Last Year
  • Issues event: 4
  • Watch event: 3
  • Issue comment event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 4
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 4
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • kaat0 (4)
  • j-weck (1)
  • apriljunge (1)
Pull Request Authors
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Dependencies

.github/workflows/cffvalidating.yaml actions
  • actions/checkout v3 composite
  • citation-file-format/cffconvert-github-action 2.0.0 composite
.github/workflows/debug.yaml actions
  • actions/checkout v3 composite
  • lhotari/action-upterm v1 composite
  • paolobrasolin/setup-texlive-action v1 composite
.github/workflows/release.yaml actions
  • StuYarrow/publish-release v1 composite
  • actions/checkout v3 composite
  • actions/create-release v1 composite
  • actions/download-artifact v3 composite
  • actions/upload-artifact v3 composite
  • actions/upload-release-asset v1 composite
  • dawidd6/action-get-tag v1 composite
  • devigned/go-twitter-action v1 composite
  • paolobrasolin/setup-texlive-action v1 composite
  • stefanzweifel/git-auto-commit-action v4 composite
.github/workflows/testing.yaml actions
  • actions/checkout v3 composite
  • paolobrasolin/setup-texlive-action v1 composite
.github/workflows/zenodo.yaml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/upload-artifact v3 composite
  • github-actions-x/commit v2.8 composite