Skip to main content

carculator_truck

Prospective environmental and economic life cycle assessment of freight vehicles, with coupled payload, range, energy storage and charging infrastructure.

Installed artifacts PyPI

Developed at the Paul Scherrer Institute. This checkout prepares the unpublished release 0.5.2; see CHANGELOG.md for release status and changes.

Installation

Use Python 3.12 (>=3.12,<3.13) and a fresh environment. The shared runtime requires NumPy >=1.26.4,<2.

python3.12 -m venv .venv
source .venv/bin/activate

On Windows, activate with .venv\Scripts\activate. After publication, install this release from PyPI:

python -m pip install "carculator_truck==0.5.2"

Before publication, use the matching source checkouts as described under development. Core calculations use bundled resources and need no Brightway project, ecoinvent installation or network access. The matching carculator_utils runtime installs brightpath>=1.0.0a6,<1.1 for Brightway Excel, SimaPro CSV and openLCA JSON-LD exports. It uses Brightpath's v1 API, currently an alpha; model and LCIA calculations do not import Brightpath or Brightway.

The excel extra remains a compatibility alias. To select the tested legacy Brightway stack (bw2io<0.9, bw2data<4, bw2calc<2), use:

python -m pip install "carculator_truck[brightway]==0.5.2"

Brightpath also installs bw2io without that extra. Export targets ecoinvent 3.12 cut-off by default; legacy 3.9/3.10 targets reject suppliers without verified older links. External suppliers must be matched to the corresponding background in the destination tool. See inventory export.

Quick start

from carculator_truck import (
    TruckInputParameters,
    TruckModel,
    InventoryTruck,
    fill_xarray_from_input_parameters,
)

inputs = TruckInputParameters()
inputs.static()
_, array = fill_xarray_from_input_parameters(
    inputs,
    scope={"size": ["40t"], "powertrain": ["ICEV-d", "BEV"], "year": [2025]},
)
model = TruckModel(array, cycle="Long haul")
model.set_all()
print(model["TtW energy"])  # kJ per vehicle-kilometre

inventory = InventoryTruck(model, functional_unit="tkm")
impacts = inventory.calculate_impacts()
print(impacts.sel(impact_category="climate change").sum("impact"))

Truck model costs are per vehicle-kilometre; the example reports impacts per tonne-kilometre of actual cargo.

Inventory export

With the completed inventory from the quick start:

workbook = inventory.export_lci(software="brightway2", format="file", directory="exports")
simapro_csv = inventory.export_lci(software="simapro", format="file", directory="exports")
foreground_zip = inventory.export_lci(software="openlca", format="file", directory="exports")

Retain exactly one sample before constructing the model and inventory. Each year gets its own export; multiple years return a list. Exports preserve the original inventory and calculated impacts. The default export_lci() returns an unlinked Brightway importer.

The openLCA ZIP contains foreground processes, without an ecoinvent background or LCIA methods; map external providers and elementary flows before calculation. SimaPro CSV uses Latin-1 and warns when omitting custom noise flows. See the export guide for return types, sample selection and format-specific limitations.

Modelling and validation

For a guided explanation of the inputs, units and assumptions, read Understanding inputs and results. The validation examples include bar charts, source records and the limits of each comparison. Measured energy comparisons are separate from the model-to-model comparison of the background database update.

The vehicle models include tabulated 2025 parameters and documented temporal extensions. These combine engineering assumptions and selected calibration evidence; they are not independent measurements for every vehicle configuration.

TtW energy is in kJ/km. For BEVs it is net stored-energy depletion; model.battery_terminal_energy reports terminal DC separately, while electricity consumption is grid electricity in kWh/km. Identify the measurement boundary before comparing energy outputs. Availability-masked zeroes do not represent physically zero consumption.

Supported background scenarios are SSP2-NPi, SSP2-PkBudg1000, SSP2-PkBudg650, and static. ReCiPe supports midpoint/endpoint and EF midpoint. Use fresh model instances for independent cases. inputs.stochastic(n, seed=...) seeds parameter draws and the projected-cost factors used by the current array builder. Keep its auxiliary sample coordinates; older hand-built arrays do not recover that seed automatically.

See validation and limitations, migration notes and the documentation.

Development and release

Use matching sibling checkouts, especially carculator_utils 1.3.7 or newer:

python -m pip install -e "../carculator_utils[test,excel,brightway]" -e ".[test,docs,excel,brightway]"
python -m pip check
python -m pytest
python -m sphinx -b html docs docs/_build/html

The docs extra includes the extensions used by this repository. See RELEASING.md for artifact verification, release order and publication.

Support and license

Contact carculator@psi.ch or open an issue. Maintained by Romain Sacchi, with contributions from the carculator development team. See contributing. Licensed under BSD-3-Clause.

Scientific background: Sacchi, Bauer and Cox (2021), Does Size Matter?.

The shared LCA background now uses premise 2.5.4 and ecoinvent 3.12 cutoff. The former NMC-523 option is replaced by NMC-532 (actual Ni:Mn:Co 5:3:2 inventory); update custom chemistry selections. See docs/release.rst.

Metadata

Release files for carculator-truck 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for carculator-truck 0.5.2
File Size Uploaded
carculator_truck-0.5.2.tar.gz 747.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for carculator-truck 0.5.2
File Interpreter ABI Platform
carculator_truck-0.5.2-py3-none-any.whl Python 3 none any Details

Total release size: 880.2 kB

Release files / carculator_truck-0.5.2.tar.gz

Download URL carculator_truck-0.5.2.tar.gz
Size 747.3 kB
Tags Source
SHA-256 checksum
How to use checksums
54e3384f527cc624f54786252857212567bddabbafa84feea6e2f99e69091b84
BLAKE2b-256 checksum
How to use checksums
07ac85cde04b1c88d3e26c0c947199f9ad8c1880d0141ef2093366a1c8dd13a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / carculator_truck-0.5.2-py3-none-any.whl

Download URL carculator_truck-0.5.2-py3-none-any.whl
Size 132.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8f1d820fbeaf2421826ade29dfa3cb6b12c4dadf3115cb654e827bef4fcc80d3
BLAKE2b-256 checksum
How to use checksums
7287d4c80231e2188b608f7ec077a0edece8e9dc2187fe7d19376e0f984afa94
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.5.2 This release

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.2

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.3

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page