Metadata-Version: 2.4
Name: eegunity
Version: 0.5.4
Summary: An open source Python pacakge for large-scale EEG datasets processing
Home-page: https://github.com/Baizhige/EEGUnity
Author: EEGUnity Team
Author-email: chengxuan.qin@outlook.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7, <3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mne>=1.5.1
Requires-Dist: numpy<2.0.0,>=1.21.0
Requires-Dist: matplotlib>=3.7.3
Requires-Dist: h5py>=3.12.1
Requires-Dist: openai==1.35.1
Requires-Dist: pdfplumber>=0.11.4
Requires-Dist: pandas>=2.1.3
Requires-Dist: scipy>=1.11.2
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<img src="./docs/source/_static/logo.png" alt="Project Logo" width="20%">

## Overview

EEGUnity is a Python package designed for processing and analyzing `large-scale EEG data` efficiently. This guide will walk you through the Usage on Windows, macOS, and Linux. 
For more details on the motivation, concepts, and vision behind this project, please refer to the paper [EEGUnity: Open-Source Tool in Facilitating Unified EEG Datasets Towards Large-Scale EEG Model](https://arxiv.org/abs/2410.07196)

## Project Documentation
You can view the API Reference and Tutorial through the following link: [Click here to view the manual](https://eegunity.readthedocs.io/en/latest/)

## Usage in Python Project
### 1. Create a Python Environment
Ensure you are using Python version 3.6 or higher.

### 2. Install EEGUnity via pip
Run the following command to install EEGUnity:
```bash
pip install eegunity
```

### 3. Import EEGUnity in Your Python Project
Use the following import statement to include the package:
```python
from eegunity import UnifiedDataset
```

## Tutorial
1. How to Format Channel Name and Inspect Channel Data: [Click here to view the tutorial](./docs/source/tutorial/How%20to%20Format%20Channel%20Name%20and%20Inspect%20Metadata.md)
2. How to Process Data and Export as h5Dataset: [Click here to view the tutorial](./docs/source/tutorial/How%20to%20Process%20Data%20and%20Export%20as%20h5Dataset.md)
3. How to Read h5Dataset: [Click here to view the tutorial](./docs/source/tutorial/How%20to%20Read%20h5Dataset.md)
4. How to Make Standard Datasets: [Click here to view the tutorial](./docs/source/tutorial/How%20to%20Make%20Standard%20Datasets.md)
