Skip to content

quickstart.md

Latest commit

 

History

History
112 lines (81 loc) · 3.45 KB

quickstart.md

File metadata and controls

112 lines (81 loc) · 3.45 KB
Raw

Quick Start

This tutorial walks you through installing PyNeats and running your first climate impact computation.

Prerequisites

  • Python 3.11+
  • uv (recommended package manager)
  • BADA data — EUROCONTROL aircraft performance coefficients (required for full pipeline)
  • Weather data — DWD ICON or ERA5 meteorological data in Zarr format

Step 1: Install

git clone https://github.com/eurocontrol-asu/PyNeats.git
cd PyNeats
make install

This runs uv sync and installs external dependencies (PyBADA, open-airclim).

Verify installation

make test-unit

Unit tests run without external data.

Step 2: Prepare Data

PyNeats requires two external data sources:

Data Format Source
BADA coefficients Directory EUROCONTROL (licensed)
Weather Zarr store DWD ICON or ERA5

Set the paths as environment variables or pass them as CLI arguments:

export BADA_PATH=/path/to/bada/data
export WEATHER_PATH=/path/to/weather/zarr

Step 3: Run the Pipeline

Process a fleet of flights from a JSON file:

uv run python examples/fleet_computation_from_json.py \
  --json-file tests/data/golden/fleet_5_flights_input.json \
  --weather-path $WEATHER_PATH \
  --bada-path $BADA_PATH \
  --njobs 4

The pipeline executes these steps sequentially for each flight:

  1. Parse — Extract 4D trajectory from input data
  2. Interpolate — Resample to 60-second intervals
  3. Weather — Intersect trajectory with meteorological fields
  4. Performance — Compute fuel flow and thrust via BADA
  5. Emissions — Calculate emission indices (NOₓ, nvPM, etc.)
  6. Climate functions — Estimate climate forcing (CoCiP, aCCFs)
  7. Climate metrics — Convert to GWP / CO₂-equivalent

Alternative parsers

By default PyNeats uses NeatsTrajectoryParser (registered as "neats") for NEATS JSON format. For OpenSky ADS-B data, use OpenSkyParser (registered as "adsb"). Both implement the TrajectoryParser protocol (an interface, not an instantiable class) and are selected by name via the step registry:

from pyneats.core.steps_registry import build
from pyneats.steps.parsing.protocol import TrajectoryParser

# Default — returns a NeatsTrajectoryParser instance
parser = build(TrajectoryParser, "neats")

# OpenSky ADS-B — returns an OpenSkyParser instance
parser = build(TrajectoryParser, "adsb")

build(Protocol, name, **params) looks up the registered implementation and instantiates it with the given parameters. Any class decorated with @register(TrajectoryParser, "<name>") is interchangeable — see Extending Steps to plug in a custom parser.

Step 4: Run Tests

# Unit tests only (no external data required)
make test-unit

# Full test suite
make test BADA_PATH=/path/to/bada WEATHER_PATH=/path/to/weather

# Fast (no coverage)
make test-fast BADA_PATH=/path/to/bada

Next Steps