cetos 0.0.0

A Python package for analyzing vessel data.

cetos

Open-source tools for analyzing vessel data.

Overview

cetos provides tools for analyzing vessel performance, estimating fuel consumption, and evaluating energy systems for maritime vessels. It implements methodologies from the IMO Fourth GHG Study 2020.

Features

• Fuel Consumption Estimation: Calculate vessel fuel consumption based on IMO methodologies
• Energy System Analysis: Analyze batteries, hydrogen systems, and hybrid propulsion
• AIS Data Processing: Convert AIS data to voyage profiles
• Multiple Vessel Types: Support for various vessel types (ferries, container ships, tankers, etc.)

Installation

Install cetos using pip:

pip install cetos

Quick Start

from cetos import imo

# Define vessel characteristics
vessel_data = {
    "length": 39.8,  # meters
    "beam": 10.46,  # meters
    "design_speed": 13.5,  # knots
    "design_draft": 2.84,  # meters
    "double_ended": False,
    "number_of_propulsion_engines": 4,
    "propulsion_engine_power": 330,  # kW per engine
    "propulsion_engine_type": "MSD",
    "propulsion_engine_age": "after_2000",
    "propulsion_engine_fuel_type": "MDO",
    "type": "ferry-pax",
    "size": 686,  # GT
}

# Define voyage profile
voyage_profile = {
    "time_anchored": 10.0,  # hours
    "time_at_berth": 10.0,  # hours
    "legs_manoeuvring": [(10, 10, 6)],  # (distance, speed, draft)
    "legs_at_sea": [(30, 10, 6), (30, 10, 6)],
}

# Calculate fuel consumption
results = imo.calculate_fuel_consumption(vessel_data, voyage_profile)
print(f"Total fuel consumption: {results['total_fuel']} tonnes")

Modules

IMO Module (cetos.imo)

Functions for estimating vessel fuel consumption based on IMO Fourth GHG Study 2020 methodologies.

Energy Systems (cetos.energy_systems)

Tools for analyzing vessel energy systems including batteries, hydrogen, and internal combustion engines.

AIS Adapter (cetos.ais_adapter)

Process AIS (Automatic Identification System) data and convert it to voyage profiles.

Analysis (cetos.analysis)

Additional analysis tools for vessel performance evaluation.

Development

Quick Setup with uv (Recommended)

uv is a fast Python package installer and resolver:

# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone https://github.com/RISE-Maritime/cetos.git
cd cetos

# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -e ".[dev]"

Using pip

# Clone the repository
git clone https://github.com/RISE-Maritime/cetos.git
cd cetos

# Create and activate virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install in editable mode with dev dependencies
pip install -e ".[dev]"

Using Dev Containers

This repository includes a dev container configuration for VS Code. Simply open the repository in VS Code and select "Reopen in Container" when prompted.

Running Tests

pytest tests/

Code Formatting

black .
ruff check --fix .

Contributing

Contributions are welcome!

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

References

[1] IMO. Fourth IMO GHG Study 2020. International Maritime Organization.

Contact

• Issues: GitHub Issues
• Discussions: GitHub Discussions