ECTMetrics/structure.txt at main · maxkayser/ECTMetrics · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
EctMetrics
│
├── assets/                   		          # Assets directory
│   ├── ectmetrics-ect_seizure_quality_metrics.png
│   └── ectmetrics-plotted_eeg_signal.png
│
├── ectmetrics/                   		          # Main package directory
│   ├── __init__.py            	 	              # Package initialization file
│   ├── eeg.py             				          # EEG signal generation and processing
│   └── metrics.py            			          # Functions for ECT metric calculations
│
├── tests/                    				      # Directory for tests
│   ├── __init__.py           			          # Test package initialization file
│   ├── test_eeg.py        			              # Tests for signal.py
│   └── test_metrics.py      		              # Tests for metrics.py
│
├── examples/                 			          # Examples of how to use the library
│   ├── example_simple.py              	          # Example how to use the basic functions
│   ├── example_eeg_signal_generation.py          # Example how to generate EEG signals
│   ├── example_eeg_signal_import.py              # Example how to import EEG signals
│   └── example_ect_metrics_calculation.ipynb     # Example how to calculate ECT seizure quality metrics
│
├── docs/                     				      # Documentation
│   ├── build/
│   └── source/
│
├── CITATIONS.md                 		          # Informations on how to cite this repository
├── CONTACT.md                 		            # Contact information
├── DISCLAIMER.md                 		        # Legal disclaimer
├── LICENSE                 		              # License details
├── pyproject.toml                            # Configuration for build system and project metadata
├── README.md                 		            # Project description and instructions
├── requirements.txt          		            # Dependencies for the project
├── setup.py                  		        	  # Setup script for installation
├── structure.txt                 		        # Project structure
└── .gitignore                		        	  # Files and directories to be ignored by Git