eegkit/edf-epoch

create epoch from edf file

edf epoch

EDF+ epoch creation tool
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

This code snippet will create an epoch from an EDF+ file given a start and end time in seconds.

Built With

• Python version: 3.9

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• No Prerequisites required. Any Python3 version will suffice.

Installation

1. In a terminal, clone the repo by running:

   git clone https://github.com/greydongilmore/edf-epoch.git

2. Change into the project directory (update path to reflect where you stored this project directory):

   cd /home/user/Documents/Github/edf-epoch

3. Install the required Python packages:

   python -m pip install -r requirements.txt

Usage

1. In a terminal, move into the project directory

   cd /home/user/Documents/Github/edf-epoch

2. Run the following to execute the epoch script:

   python main.py -i "full/path/to/edf/file" -s 10 -e 400

• -i: full file path to the EDF file you want to epoch
• -s: starting time for the epoch (in seconds)
• -e: ending time for the epoch (in seconds)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Greydon Gilmore - @GilmoreGreydon - [email protected]

Project Link: https://github.com/greydongilmore/edf-epoch

Acknowledgements

• README format was adapted from Best-README-Template