eegunity 0.5.0__tar.gz

eegunity-0.5.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+​
+Copyright (c) 2022-present, EEGUnity Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+​
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+​
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

eegunity-0.5.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-include eegunity *

eegunity-0.5.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.2
+Name: eegunity
+Version: 0.5.0
+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.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mne>=1.5.1
+Requires-Dist: numpy>=1.24.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: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# EEGUnity
+
+## 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)
+
+## Usage in Python Project
+(Notes: This repository is planned for release on PyPI and the Conda community once a stable version is achieved.)
+### Prerequisites
+
+- Python 3.x
+- Git
+- See [requirements.txt](docs%2Frequirements.txt)
+
+### Clone the Repository
+
+First, clone the repository using Git:
+
+#### Windows, macOS and Linux:
+```bash
+git clone https://github.com/Baizhige/EEGUnity/.git
+```
+
+### Usage in Python Projects
+
+To use EEGUnity in your Python project, you will need to copy the `eegunity` folder to your project directory:
+
+1. **Copy the `eegunity` folder** from the cloned repository to your Python project's folder:
+   
+   #### Windows:
+   - Copy `EEGUnity\eegunity` into your project's directory.
+   
+   #### macOS and Linux:
+   - Copy `EEGUnity/eegunity` into your project's directory.
+
+2. Your project structure should resemble the following:
+```
+my_project/
+│
+├── eegunity/
+│   └── __init__.py
+└── your_script.py
+```
+3. Import the package in your Python project like this:
+
+   ```python
+   from eegunity import UnifiedDataset
+   ```
+
+# Tutorial
+1. How to Format Channel Name and Inspect Channel Data: [Click here to view the tutorial](./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](./tutorial/How%20to%20Process%20Data%20and%20Export%20as%20h5Dataset.md)
+3. How to Read h5Dataset: [Click here to view the tutorial](./tutorial/How%20to%20Read%20h5Dataset.md)
+
+
+# Project Documentation
+You can view the project manual through the following link: [Click here to view the manual](https://eegunity.readthedocs.io/en/latest/)

eegunity-0.5.0/README.md

@@ -0,0 +1,58 @@
+# EEGUnity
+
+## 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)
+
+## Usage in Python Project
+(Notes: This repository is planned for release on PyPI and the Conda community once a stable version is achieved.)
+### Prerequisites
+
+- Python 3.x
+- Git
+- See [requirements.txt](docs%2Frequirements.txt)
+
+### Clone the Repository
+
+First, clone the repository using Git:
+
+#### Windows, macOS and Linux:
+```bash
+git clone https://github.com/Baizhige/EEGUnity/.git
+```
+
+### Usage in Python Projects
+
+To use EEGUnity in your Python project, you will need to copy the `eegunity` folder to your project directory:
+
+1. **Copy the `eegunity` folder** from the cloned repository to your Python project's folder:
+   
+   #### Windows:
+   - Copy `EEGUnity\eegunity` into your project's directory.
+   
+   #### macOS and Linux:
+   - Copy `EEGUnity/eegunity` into your project's directory.
+
+2. Your project structure should resemble the following:
+```
+my_project/
+│
+├── eegunity/
+│   └── __init__.py
+└── your_script.py
+```
+3. Import the package in your Python project like this:
+
+   ```python
+   from eegunity import UnifiedDataset
+   ```
+
+# Tutorial
+1. How to Format Channel Name and Inspect Channel Data: [Click here to view the tutorial](./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](./tutorial/How%20to%20Process%20Data%20and%20Export%20as%20h5Dataset.md)
+3. How to Read h5Dataset: [Click here to view the tutorial](./tutorial/How%20to%20Read%20h5Dataset.md)
+
+
+# Project Documentation
+You can view the project manual through the following link: [Click here to view the manual](https://eegunity.readthedocs.io/en/latest/)

eegunity-0.5.0/eegunity/__init__.py

@@ -0,0 +1 @@
+from .unifieddataset import UnifiedDataset

eegunity-0.5.0/eegunity/_modules/batch/__init__.py

@@ -0,0 +1 @@
+from .eeg_batch import EEGBatch