Metadata-Version: 2.3
Name: flowcean
Version: 0.1.0
Summary: Automatic generation of models for cyber-physical systems.
Project-URL: Documentation, https://www3.tuhh.de/agenc/
Project-URL: Issues, https://github.com/flowcean/flowcean/issues
Project-URL: Source, https://github.com/flowcean/flowcean
Author-email: The AGenC Team <agenc.team@tuhh.de>
License-File: AUTHORS
License-File: LICENSE.txt
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Requires-Dist: numpy<2
Requires-Dist: polars
Requires-Dist: ruamel-yaml
Requires-Dist: tqdm
Requires-Dist: typing-extensions
Provides-Extra: all
Requires-Dist: docker; extra == 'all'
Requires-Dist: grpcio; extra == 'all'
Requires-Dist: lightning; extra == 'all'
Requires-Dist: protobuf; extra == 'all'
Requires-Dist: rosbags; extra == 'all'
Requires-Dist: rosbags-dataframe; extra == 'all'
Requires-Dist: scikit-learn; extra == 'all'
Requires-Dist: tensorboard; extra == 'all'
Provides-Extra: grpc
Requires-Dist: docker; extra == 'grpc'
Requires-Dist: grpcio; extra == 'grpc'
Requires-Dist: protobuf; extra == 'grpc'
Provides-Extra: lightning
Requires-Dist: lightning; extra == 'lightning'
Requires-Dist: tensorboard; extra == 'lightning'
Provides-Extra: ros
Requires-Dist: rosbags; extra == 'ros'
Requires-Dist: rosbags-dataframe; extra == 'ros'
Provides-Extra: sklearn
Requires-Dist: scikit-learn; extra == 'sklearn'
Description-Content-Type: text/markdown

# Flowcean

![ci status](https://github.com/flowcean/flowcean/actions/workflows/ci.yml/badge.svg)
[![docs status](https://github.com/flowcean/flowcean/actions/workflows/pages.yml/badge.svg)](https://flowcean.me)
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![types - Pyright](https://img.shields.io/badge/types-Pyright-blue.svg)](https://github.com/microsoft/pyright)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

The flowcean framework.

## Building the Documentation

First, install hatch.

```bash
pipx install hatch
```

Then, build the documentation:

```bash
hatch run docs:build
```

After the documentation has been built, you can open it in your browser by opening `site/index.html`.

Alternatively, run:

```bash
hatch run docs:serve
```

to get an interactively reloading session of the documentation.
