Data

Tools

Indexes

Applications

Experiments

Open Source Science

altrios

https://github.com/nrel/altrios

Science Score: 36.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 14 committers (7.1%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary

Keywords from Contributors

projection interactive serializer cycles packaging charts network-simulation shellcodes hacking autograding
Last synced: 10 months ago · JSON representation

Repository

Basic Info
Statistics
  • Stars: 23
  • Watchers: 6
  • Forks: 11
  • Open Issues: 19
  • Releases: 16
Created about 3 years ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

ALTRIOS

Altrios Logo

homepage rust-tests py-tests wheels Python Documentation GitHub

Model Framework Schematic

The Advanced Locomotive Technology and Rail Infrastructure Optimization System (ALTRIOS) is a unique, fully integrated, open-source software tool to evaluate strategies for deploying advanced locomotive technologies and associated infrastructure for cost-effective decarbonization. ALTRIOS simulates freight-demand driven train scheduling, mainline meet-pass planning, locomotive dynamics, train dynamics, energy conversion efficiencies, and energy storage dynamics of line-haul train operations. Because new locomotives represent a significant long-term capital investment and new technologies must be thoroughly demonstrated before deployment, this tool provides guidance on the risk/reward tradeoffs of different technology rollout strategies. An open, integrated simulation tool is invaluable for identifying future research needs and making decisions on technology development, routes, and train selection. ALTRIOS was developed as part of a collaborative effort by a team comprising The National Renewable Energy Laboratory (NREL), University of Texas (UT), Southwest Research Institute (SwRI), and BNSF Railway.

Much of the core code in ALTRIOS is written in the Rust Programming Language to ensure excellent computational performance and robustness, but we've built ALTRIOS with the intent of users interacting with the code through our feature-rich Python interface.

Installation

If you are an ALTRIOS developer, see Developer Documentation. Otherwise, read on.

Python Setup

  1. Python installation options:
    • Option 1 -- Python: https://www.python.org/downloads/. We recommend Python 3.10. Be sure to check the Add to PATH option during installation.
    • Option 2 -- Anaconda: we recommend https://docs.conda.io/en/latest/miniconda.html.

  2. Setup a python environment. ALTRIOS can work with Python 3.9, or 3.10, but we recommend 3.10 for better performance and user experience. Create a python environment for ALTRIOS with either of two methods:

    • Option 1 -- Python Venv

      1. Navigate to the ALTRIOS folder you just cloned or any folder you'd like for using ALTRIOS. Remember the folder you use!
      2. Assuming you have Python 3.10 installed, run
        • (path to your python3.10 e.g. ~/AppData/Local/Programs/Python/Python310/python.exe) -m venv altrios-venv in Windows
        • python3.10 -m venv altrios-venv in Mac/Unix/Linux in your terminal enviroment (we recommend PowerShell in Windows, which comes pre-installed).

      This tells Python 3.10 to use the venv module to create a virtual environment (which will be ignored by git if named altrios-venv) in the ALTRIOS/altrios-venv/. 1. Activate the environment you just created to install packages or anytime you're running ALTRIOS: - Mac and Linux: source altrios-venv/bin/activate - Windows: altrios-venv/Scripts/activate.bat in a windows command prompt or power shell or source altrios-venv/Scripts/activate in git bash terminal - When the environment is activated, your terminal session will have a decorator that looks like (altrios-venv).

    • Option 2 -- Anaconda:

      1. Open an Anaconda prompt (in Windows, we recommend Anaconda Powershell Prompt) and run the command conda create -n altrios python=3.10 to create an Anaconda environment named altrios.
      2. Activate the environment to install packages or anytime you're running ALTRIOS: run conda activate altrios.

ALTRIOS Setup

With your Python environment activated, run pip install altrios.

Congratulations, you've completed installation! Whenever you need to use ALTRIOS, be sure to activate your python environment created above.

How to run ALTRIOS

With your activated Python environment with ALTRIOS fully installed, you can download the demo scripts to the current working directory inside of a demos/ folder with: python import altrios as alt alt.copy_demo_files() You can run the Simulation Manager through a multi-week simulation of train operations in by running python sim_manager_demo.py in demos/. This will create a plots/ subfolder in which the plots will be saved. To run interactively, fire up a Python IDE (e.g. VS Code, Spyder), and run the file. If you're in VS Code, you can run the file as a virtual jupyter notebook because of the "cells" that are marked with the # %% annotation. You can click on line 2, for example, and hit <Shift> + <Enter> to run the current cell in an interactive terminal (which will take several seconds to launch) and advance to the next cell. Alternatively, you can hit <Ctrl> + <Shift> + p to enable interactive commands and type "run current cell". There are several other python files in the demos/ folder to demonstrate various capabilities of ALTRIOS.

If you plan to modify the data used in the demo files, copy the data files to your local directory and load them from there, e.g.
python res = alt.ReversibleEnergyStorage.from_file( alt.resources_root() / "powertrains/reversible_energy_storages/Kokam_NMC_75Ah_flx_drive.yaml" ) would become
python res = alt.ReversibleEnergyStorage.from_file( "./custom_battery.yaml" )

Nearly every code object in ALTRIOS can be read from or written to common data formats. For more details, see the SerdeAPI trait documentation. All of the functions in the SerdeAPI are available through the python interface.

Acknowledgements

  The ALTRIOS Team would like to thank ARPA-E for financially supporting the research through the LOCOMOTIVES program and Dr. Robert Ledoux for his vision and support. We would also like to thank the ARPA-E team for their support and guidance: Dr. Apoorv Agarwal, Mirjana Marden, Alexis Amos, and Catherine Good. We would also like to thank BNSF for their cost share financial support, guidance, and deep understanding of the rail industry’s needs. Additionally, we would like to thank Jinghu Hu for his contributions to the core ALTRIOS code. We would like to thank Chris Hennessy at SwRI for his support. Thank you to Michael Cleveland for his help with developing and kicking off this project.

Owner

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

GitHub Events

Total
  • Create event: 49
  • Release event: 4
  • Issues event: 13
  • Watch event: 4
  • Delete event: 13
  • Member event: 4
  • Issue comment event: 34
  • Push event: 316
  • Pull request review comment event: 29
  • Pull request event: 58
  • Pull request review event: 34
  • Fork event: 6
Last Year
  • Create event: 49
  • Release event: 4
  • Issues event: 13
  • Watch event: 4
  • Delete event: 13
  • Member event: 4
  • Issue comment event: 34
  • Push event: 316
  • Pull request review comment event: 29
  • Pull request event: 58
  • Pull request review event: 34
  • Fork event: 6

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 895
  • Total Committers: 14
  • Avg Commits per committer: 63.929
  • Development Distribution Score (DDS): 0.245
Past Year
  • Commits: 361
  • Committers: 8
  • Avg Commits per committer: 45.125
  • Development Distribution Score (DDS): 0.307
Top Committers
Name Email Commits
Chad Baker c****r@n****v 676
Bruchon, Matthew M****n@n****v 89
FDsteven f****w@g****m 42
sakhtar s****r@n****v 33
Nicholas Reinicke n****e 15
StevenGotGame d****1@i****u 13
dependabot[bot] 4****] 8
Garrett Anderson g****t@b****t 6
D03\ganderson g****n@s****g 3
Kyle Carow 4****w 3
Kyle Carow K****w@n****v 3
sakhtar312 1****2 2
Matthew Bruchon m****o@g****m 1
hpanneer h****m@n****v 1
Committer Domains (Top 20 + Academic)
nrel.gov: 5 swri.org: 1 benchdata.net: 1 illinois.edu: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 14
  • Total pull requests: 206
  • Average time to close issues: 10 months
  • Average time to close pull requests: 17 days
  • Total issue authors: 6
  • Total pull request authors: 11
  • Average comments per issue: 0.36
  • Average comments per pull request: 0.37
  • Merged pull requests: 158
  • Bot issues: 0
  • Bot pull requests: 8
Past Year
  • Issues: 10
  • Pull requests: 69
  • Average time to close issues: N/A
  • Average time to close pull requests: 20 days
  • Issue authors: 4
  • Pull request authors: 7
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.39
  • Merged pull requests: 43
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • calbaker (5)
  • mbbruch (3)
  • SWRIganderson (3)
  • spencerm89 (1)
  • dan-mccabe (1)
  • sakhtar312 (1)
Pull Request Authors
  • calbaker (150)
  • sakhtar312 (20)
  • mbbruch (11)
  • dependabot[bot] (8)
  • FDsteven (6)
  • nreinicke (3)
  • kylecarow (2)
  • robinsteuteville (2)
  • SWRIganderson (2)
  • garrettlanderson (1)
  • panne027 (1)
Top Labels
Issue Labels
future (2) enhancement (1)
Pull Request Labels
dependencies (8) github_actions (2) bug (2) enhancement (2)

Packages

  • Total packages: 5
  • Total downloads:
    • cargo 27,799 total
    • pypi 898 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 67
  • Total maintainers: 6
proxy.golang.org: github.com/nrel/altrios
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
proxy.golang.org: github.com/NREL/altrios
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
pypi.org: altrios

Tool for modeling and optimization of advanced locomotive powertrains for freight rail decarbonization.

  • Versions: 19
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 898 Last month
Rankings
Dependent packages count: 7.3%
Average: 24.3%
Dependent repos count: 41.4%
Maintainers (2)
nreinicke chad_baker
Last synced: 10 months ago
crates.io: altrios-proc-macros

ALTRIOS procedural macros

  • Versions: 10
  • Dependent Packages: 1
  • Dependent Repositories: 0
  • Downloads: 12,077 Total
Rankings
Dependent repos count: 30.3%
Dependent packages count: 31.7%
Stargazers count: 33.0%
Forks count: 41.2%
Average: 46.6%
Downloads: 96.8%
Maintainers (4)
calbaker nreinicke panne027 sakhtar312
Last synced: 10 months ago
crates.io: altrios-core

ALTRIOS Core model for train simulation

  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 15,722 Total
Rankings
Dependent repos count: 30.3%
Dependent packages count: 31.7%
Stargazers count: 33.0%
Forks count: 41.2%
Average: 46.8%
Downloads: 97.6%
Maintainers (4)
calbaker nreinicke panne027 sakhtar312
Last synced: 10 months ago

Dependencies

rust/Cargo.lock cargo
  • 237 dependencies
.github/workflows/tests.yaml actions
  • actions-rs/toolchain v1 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/wheels.yaml actions
  • actions-rs/toolchain v1 composite
  • actions/checkout v3 composite
  • actions/download-artifact v2 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
rust/Cargo.toml cargo
rust/altrios-core/Cargo.toml cargo
rust/altrios-core/altrios-proc-macros/Cargo.toml cargo
rust/altrios-core-py/Cargo.toml cargo
pyproject.toml pypi
  • matplotlib *
  • numpy *
  • openpyxl *
  • pandas >=2
  • plotly *
  • polars *
  • pyarrow *
  • pymoo ==0.6
  • pyyaml *
  • seaborn *
  • typing_extensions *
  • xlrd *
requirements-dev.in pypi
requirements-dev.txt pypi
  • about-time ==4.2.1 development
  • alive-progress ==3.1.2 development
  • asttokens ==2.2.1 development
  • autograd ==1.5 development
  • backcall ==0.2.0 development
  • black ==23.3.0 development
  • click ==8.1.3 development
  • cma ==3.2.2 development
  • colorama ==0.4.6 development
  • comm ==0.1.3 development
  • contourpy ==1.0.7 development
  • cycler ==0.11.0 development
  • debugpy ==1.6.7 development
  • decorator ==5.1.1 development
  • deprecated ==1.2.13 development
  • dill ==0.3.6 development
  • et-xmlfile ==1.1.0 development
  • exceptiongroup ==1.1.1 development
  • executing ==1.2.0 development
  • fonttools ==4.39.4 development
  • future ==0.18.3 development
  • grapheme ==0.6.0 development
  • iniconfig ==2.0.0 development
  • ipykernel ==6.23.0 development
  • ipython ==8.13.2 development
  • jedi ==0.18.2 development
  • jupyter-client ==8.2.0 development
  • jupyter-core ==5.3.0 development
  • kiwisolver ==1.4.4 development
  • matplotlib ==3.7.1 development
  • matplotlib-inline ==0.1.6 development
  • maturin ==0.15.1 development
  • mypy-extensions ==1.0.0 development
  • nest-asyncio ==1.5.6 development
  • numpy ==1.24.3 development
  • openpyxl ==3.1.2 development
  • packaging ==23.1 development
  • pandas ==2.0.1 development
  • parso ==0.8.3 development
  • pathspec ==0.11.1 development
  • pickleshare ==0.7.5 development
  • pillow ==9.5.0 development
  • platformdirs ==3.5.1 development
  • plotly ==5.14.1 development
  • pluggy ==1.0.0 development
  • polars ==0.17.14 development
  • prompt-toolkit ==3.0.38 development
  • psutil ==5.9.5 development
  • pure-eval ==0.2.2 development
  • pyarrow ==12.0.0 development
  • pygments ==2.15.1 development
  • pymoo ==0.6 development
  • pyparsing ==3.0.9 development
  • pytest ==7.3.1 development
  • python-dateutil ==2.8.2 development
  • pytz ==2023.3 development
  • pywin32 ==306 development
  • pyyaml ==6.0 development
  • pyzmq ==25.0.2 development
  • scipy ==1.10.1 development
  • seaborn ==0.12.2 development
  • six ==1.16.0 development
  • stack-data ==0.6.2 development
  • tenacity ==8.2.2 development
  • tomli ==2.0.1 development
  • tornado >=6.3.2 development
  • traitlets ==5.9.0 development
  • typing-extensions ==4.5.0 development
  • tzdata ==2023.3 development
  • wcwidth ==0.2.6 development
  • wrapt ==1.15.0 development
  • xlrd ==2.0.1 development
requirements.txt pypi
  • about-time ==4.2.1
  • alive-progress ==3.1.2
  • autograd ==1.5
  • cma ==3.2.2
  • contourpy ==1.0.7
  • cycler ==0.11.0
  • deprecated ==1.2.13
  • dill ==0.3.6
  • et-xmlfile ==1.1.0
  • fonttools ==4.39.4
  • future ==0.18.3
  • grapheme ==0.6.0
  • kiwisolver ==1.4.4
  • matplotlib ==3.7.1
  • numpy ==1.24.3
  • openpyxl ==3.1.2
  • packaging ==23.1
  • pandas ==2.0.1
  • pillow ==9.5.0
  • plotly ==5.14.1
  • polars ==0.17.14
  • pyarrow ==12.0.0
  • pymoo ==0.6
  • pyparsing ==3.0.9
  • python-dateutil ==2.8.2
  • pytz ==2023.3
  • pyyaml ==6.0
  • scipy ==1.10.1
  • seaborn ==0.12.2
  • six ==1.16.0
  • tenacity ==8.2.2
  • typing-extensions ==4.5.0
  • tzdata ==2023.3
  • wrapt ==1.15.0
  • xlrd ==2.0.1