Metadata-Version: 2.4
Name: watch-engineering
Version: 0.1.1
Summary: Engineering for mechanical watch design
Author: Kilian Eisenegger
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Watch Engineering

Engineering toolkit for mechanical watch design.

This library provides a collection of engineering formulas used in modern horology,
including energy modeling, hairspring design, gear trains, and mechanical components.

It is designed for:

* Watch engineers
* Horology students
* Simulation and optimization workflows
* Companion code for technical documentation and books

---

## Installation

```bash
pip install watch-engineering
```

---

## Quick Example

```python
import watch_engineering as we

power = we.escape_wheel_power(
    max_torque_nmm=8.0,
    gear_train_efficiency=0.8,
    barrel_efficiency=0.9,
    frequency_hz=4,
    escape_wheel_teeth=15,
    train_ratio=10
)

print(power)
```

---

## Features

* ⚙️ Energy and power calculations (escapement, balance, mainspring)
* 🌀 Hairspring modeling (stiffness, frequency, thermal effects)
* ⚖️ Balance inertia and optimization formulas
* 🔩 Mechanical components (bearings, springs, O-rings)
* 📊 Reliability and Weibull analysis
* 🔗 Gear train calculations

---

## Documentation

The full API reference is automatically generated:

📄 `docs/API.md`

---

## Development

Install in editable mode:

```bash
python -m pip install -e .
```

Build package:

```bash
python build\_.py
```

---

## Roadmap

* [ ] Simulation layer (energy model, Q-factor optimization)
* [ ] Design of Experiments (DOE)
* [ ] Plotting utilities
* [ ] GUI / interactive tools
* [ ] Extended documentation with examples

---

## Philosophy

Mechanical watch design combines physics, material science, and precision engineering.

This project aims to:

* Make formulas reproducible
* Enable simulation-driven design
* Bridge traditional watchmaking and modern engineering tools

---

## License

MIT License

---

## Author

Kilian Eisenegger

[watchmaking.com](https://watchmaking.com)

