Metadata-Version: 2.1
Name: ameise
Version: 0.1.2
Summary: Dev-Kit for AMEISE dataset
Home-page: https://github.com/MarcelVSHNS/ameise-dataset.git
Author: Marcel
Author-email: marcel.vosshans@hs-esslingen.de
License: Apache License 2.0
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# AMEISE Dataset

![AmeiseLogo](https://raw.githubusercontent.com/MarcelVSHNS/ameise-dataset/main/docs/Ameise_logo.png) 

Dev-Kit for [Project AMEISE](https://ameise.wandelgesellschaft.de/) records: 

## Description

The ameise-dataset is a development kit for the AMEISE dataset. It provides functionalities to unpack AMEISE record 
files and extract meta information and frames. The core functionality revolves around handling AMEISE record files 
with the .4mse extension.

## Installation

To install the ameise-dataset, you can use pip:
```console
pip install ameise
```

## Getting Started

To get started with the dataset, you can refer to the [GettingStarted.ipynb](https://github.com/MarcelVSHNS/ameise-dataset/blob/main/GettingStarted.ipynb) notebook provided in the repository. 
This notebook will guide you through the basic functionalities and usage of the dataset.
