An open API service indexing awesome lists of open source software.

https://github.com/ziaeemehr/neuro_toolbox

Single Header File C++ library for analysis of neurophysiological and simulated data.
https://github.com/ziaeemehr/neuro_toolbox

data-analysis data-science signal-processing synchronization

Last synced: 11 months ago
JSON representation

Single Header File C++ library for analysis of neurophysiological and simulated data.

Awesome Lists containing this project

README

          

# neuro_toolbox
*Single Header File* C++ library for analysis of *neurophysiological* and *simulated* data.

The online [documentation](https://ziaeemehr.github.io/neuro_toolbox/) is available.

## installation

There is no need for installation. It's a header file only library. You just need to put the header file "neuro_toolbox.hpp" from *single_header_file* directory next to your `cpp` or `cxx` files and use the library. You also need to include the header file.

```c++
#include "neuro_toolbox.hpp"
```

and access to the content with `NTB::` namespace.

### testing

neuro_toolbox use [catch2](https://github.com/catchorg/Catch2) unittest. To use tests

```shell
cd src/tests
make clean

make all # to run all tests

# or test each header file seperately
make signal_proccesing
make random_generators
make IO
```

### Dependencies

- fftw3

```shell
# on ubuntu machines
sudo apt-get update -y
sudo apt-get install -y fftw3
```

To generate documents you need to have `doxygen` installed on your machine.

```shell
# on linux machines use
sudo apt-get install doxygen
cd doc
doxygen
```

which produce `html` files.

I put the latest stable version of the library at *single_header_file* directory.

The `neuro_toolbox.hpp` file is made by a python script in this directory.