owi-metadatabase 0.1.2

Core SDK for OWI-Lab metadatabase: geometry and location data

OWI-metadatabase SDK

Core SDK for OWI-Lab metadatabase: geometry and location data processing.

A modern Python namespace package providing tools for working with offshore wind turbine geometry and location data from the OWI-metadatabase. Built with extensibility in mind using PEP 420 namespace packages.

📚 Read the Documentation

Features

• Geometry Module: Process offshore wind turbine geometries, components, and structures
• Locations Module: Handle geographic location and site data
• API Integration: Seamless connection to OWI-metadatabase API
• Extensible: Namespace package architecture supports future extensions
  • Template for future package extensions: Copier template soon available on GitHub
  • owi-metadatabase-soil,
  • owi-metadatabase-fatigue (planned)
  • owi-metadatabase-results (planned)

Installation

Quick Install

Using pip:

pip install owi-metadatabase

Using uv (recommended for development):

uv pip install owi-metadatabase

Install With Soil Extension

Using pip:

pip install "owi-metadatabase[soil]"

Using uv:

uv pip install "owi-metadatabase[soil]"

In zsh, keep the extra in quotes because [ and ] are treated as glob characters.

Development Installation

For contributing to the package:

# Clone the repository
git clone https://github.com/OWI-Lab/owi-metadatabase-sdk.git
cd owi-metadatabase-sdk

# Install with uv (recommended)
uv sync --dev

# Or with pip
pip install -e ".[dev]"

Quick Start

from owi.metadatabase.geometry.io import GeometryAPI
from owi.metadatabase.locations.io import LocationsAPI

# Initialize API clients
geometry_api = GeometryAPI(API_key='your-api-key')
locations_api = LocationsAPI(API_key='your-api-key')

# Fetch turbine geometry
turbine = geometry_api.get_geometry_turbine(turbine_id=123)

# Get location data
location = locations_api.get_location(location_id=456)

See the Quick Start Guide for more examples.

🔄 Migration from v0.10.x

If you're migrating from pwimetadatabase-preprocessor v0.10.x, see our Migration Guide.

Key Changes:

• Package name: owi-metadatabase-sdk → owi-metadatabase
• Import path: owimetadatabase_preprocessor.* → owi.metadatabase.*
• Removed modules: fatigue, soil, and results (available as package extensions) Importable via: from owi.metadatabase.fatigue import FatigueAPI (when available)

Development

This project uses modern Python tooling:

• uv: Fast Python package manager
• invoke: Task automation
• ruff: Linting and formatting
• pytest: Testing with extensive doctest coverage
• MkDocs Material: Documentation

Common Tasks

# Run tests
uv run invoke test.all

# Build documentation
uv run invoke docs.build

# Serve documentation locally
uv run invoke docs.serve

# Run code quality checks
uv run invoke quality.all

# Format code
uv run invoke quality.format

Project Structure

src/owi/metadatabase/
├── __init__.py          # Main package entry point
├── geometry/            # Geometry data processing
│   ├── io.py           # GeometryAPI
│   ├── processing.py   # OWT, OWTs classes
│   └── structures.py   # Data structures
├── locations/           # Location data handling
│   └── io.py           # LocationsAPI
└── _utils/             # Internal utilities
    ├── exceptions.py   # Custom exceptions
    └── utils.py        # Helper functions

Extensibility

This package uses PEP 420 namespace packages, allowing modular extensions. Future packages will extend the owi.metadatabase namespace:

• owi-metadatabase-fatigue (planned): Fatigue analysis tools
• owi-metadatabase-soil: Soil data processing
• Your extension: Create custom extensions using the namespace

All extensions work seamlessly together:

from owi.metadatabase.geometry import GeometryAPI     # Base
from owi.metadatabase.fatigue import FatigueAPI       # Extension
from owi.metadatabase.soil import SoilAPI             # Extension

Documentation

• Getting Started: Installation and quick start
• User Guide: Comprehensive usage guide
• API Reference: Complete API documentation
• Examples: Jupyter notebooks and code examples

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Contribution Workflow

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Make your changes with tests and documentation
4. Run quality checks: uv run invoke quality.all
5. Run tests: uv run invoke test.all
6. Commit your changes: git commit -m 'feat: add amazing feature'
7. Push to the branch: git push origin feature/amazing-feature
8. Open a Pull Request

License

This package is licensed under the GNU General Public License v3.0.

👥 Authors

owi-metadatabase is developed and maintained by the team at OWI-Lab.

Core Contributors:

• Pietro D'Antuono (@pietrodantuono)
• Arsen Melnikov (@arsmlnkv)

Acknowledgements

This package was developed as part of:

• ETF Smartlife (FOD165) project
• WILLOW (EUAR157) project

Project Status

Aspect	Status
Version
Python
Tests
Coverage
Documentation
License

Related Projects

• OWI-Lab Website: Research lab website
• OWI-metadatabase: Online database

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: [e-mail]

---

Built with ❤️ and 🧠 by OWI-Lab