Metadata-Version: 2.2
Name: covmatest
Version: 0.4.2
Summary: Alpha Waves Dataset
Home-page: https://github.com/gcattan/covmatest
Author: Gregoire Cattan
Author-email: gcattan@hotmail.fr
License: Apache 2.0
Project-URL: Bug Reports, https://github.com/gcattan/covmatest/issues
Project-URL: Source, https://github.com/gcattan/covmatest/
Keywords: EEG neuroscience test covariance matrices
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: alphawaves==0.5
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: flake8; extra == "tests"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: platform
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<img type="image/svg" src="https://byob.yarr.is/gcattan/covmatest/score"/>

# covmatest

Generate covariance matrices for testing.

## Installation

- Using pipy:

```
pip install covmatest
```

- For developers:

```
python setup.py develop
```

## Usage

### Example 1
```
from covmatest import get_covmat
n_matrices = 3
n_channels = 2
covmat = get_covmat(n_matrices, n_channels)
print(covmat)
```

### Example 2
```
from covmatest import get_covmat
n_matrices, n_channels = 3, 2
classA = get_covmat(n_matrices, n_channels, returns_A=True, returns_B=False)
classB = get_covmat(n_matrices, n_channels, returns_A=False, returns_B=True)
```

## Environment

- Ubuntu, Windows, MacOs
- Python 3.8 and 3.9

## How to cite?

G. Cattan, covmatest. 2021. [Online]. Available: https://github.com/gcattan/covmatest/
DOI: https://doi.org/10.5281/zenodo.5574548
