Metadata-Version: 2.1
Name: vessel-performance
Version: 0.1.0
Summary: A library for calculating and analyzing vessel performance
Home-page: https://github.com/yourusername/vessel-performance
Author: Shane Lee
Author-email: liqiyuworks@163.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.19.0
Requires-Dist: pandas>=1.2.0
Requires-Dist: scipy>=1.6.0
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov>=2.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Requires-Dist: flake8>=3.9; extra == "dev"

# Vessel Performance

A Python library for calculating and analyzing vessel performance metrics.

## Features

- Calculate vessel fuel efficiency
- Analyze vessel speed and power relationships
- Estimate vessel performance under different weather conditions
- Generate performance reports and visualizations

## Installation

You can install the package via pip:

```bash
pip install vessel-performance
```

## Quick Start

```python
from vessel_performance import VesselAnalyzer

# Create a vessel analyzer instance
analyzer = VesselAnalyzer()

# Calculate fuel efficiency
efficiency = analyzer.calculate_fuel_efficiency(
    fuel_consumption=100,  # tons per day
    vessel_speed=14,       # knots
    displacement=50000     # tons
)

# Analyze speed-power relationship
power_curve = analyzer.get_speed_power_curve(
    speed_range=[10, 15, 20],  # knots
    vessel_data={
        "length": 200,         # meters
        "beam": 32,           # meters
        "draft": 12           # meters
    }
)
```

## Documentation

For detailed documentation, please visit our [documentation site](https://vessel-performance.readthedocs.io/).

## Contributing

We welcome contributions! Please see our [contributing guide](CONTRIBUTING.md) for details.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. 
