Skip to content

Commit

Permalink
Update versions
Browse files Browse the repository at this point in the history
  • Loading branch information
tsbinns committed Sep 18, 2024
1 parent fa10009 commit e53cdc6
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 28 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
![](docs/source/_static/logo.gif)
![PyBispectra logo](docs/source/_static/logo.gif)

A Python signal processing package for computing spectral- and time-domain
interactions using the bispectrum.
A Python signal processing package for computing spectral- and time-domain interactions using the bispectrum.

This package provides the tools for computing phase-amplitude coupling, time
delay estimation, and wave shape features using the bispectrum and bicoherence.
Additional tools for computing amplitude-amplitude coupling, phase-phase
coupling, and spatio-spectral filters are also provided.
This package provides the tools for computing phase-amplitude coupling, time delay estimation, and wave shape features using the bispectrum and bicoherence. Additional tools for computing amplitude-amplitude coupling, phase-phase coupling, and spatio-spectral filters are also provided.

Parallel processing and [Numba](https://numba.pydata.org/) optimisation are
implemented to reduce computation times. There is a minor reliance on the
[MNE](https://mne.tools/stable/index.html) signal processing toolbox.
Parallel processing and [Numba](https://numba.pydata.org/) optimisation are implemented to reduce computation times.

## Installation & Requirements:
Install the package into the desired environment using pip `pip install pybispectra`<br/>
[See here for the list of requirements](requirements.txt).
More information [here](https://pybispectra.readthedocs.io/en/1.2.0/installation.html)

## Use:
To get started with the toolbox, check out the [documentation](https://pybispectra.readthedocs.io/en/main/) and [examples](https://pybispectra.readthedocs.io/en/main/examples.html).
To get started with the toolbox, check out the [documentation](https://pybispectra.readthedocs.io/en/1.2.0/) and [examples](https://pybispectra.readthedocs.io/en/1.2.0/examples.html).

## Citing:
If you use this toolbox in your work, please include the following citation:<br/>
Expand Down
2 changes: 1 addition & 1 deletion changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PyBispectra Changelog

## [Version 1.2.0dev](https://pybispectra.readthedocs.io/en/main/)
## [Version 1.2.0](https://pybispectra.readthedocs.io/en/1.2.0/)

##### Enhancements
- Added general `Bispectrum` and `Threenorm` classes for computing with flexible kmn channel combinations.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/_static/versions.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[
{
"name": "1.2.0dev",
"version": "1.2.0dev",
"url": "https://pybispectra.readthedocs.io/en/main/"
"name": "1.2.0",
"version": "1.2.0",
"url": "https://pybispectra.readthedocs.io/en/1.2.0/"
},
{
"name": "1.1.0",
Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
from pybispectra.utils._docs import linkcode_resolve

project = "PyBispectra"
copyright = "2023, Thomas Samuel Binns"
author = "Thomas Samuel Binns"
release = "1.2.0dev"
copyright = "2023, Thomas S. Binns"
author = "Thomas S. Binns"
release = "1.2.0"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ build-backend = "hatchling.build"
requires = ["hatchling"]

[project]
authors = [{email = "[email protected]", name = "Thomas Samuel Binns"}]
authors = [{email = "[email protected]", name = "Thomas S. Binns"}]
classifiers = [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
Expand All @@ -14,7 +14,7 @@ description = "A Python signal processing package for computing spectral-domain
name = "pybispectra"
readme = "README.md"
requires-python = ">=3.10"
version = "1.2.0dev"
version = "1.2.0"

[project.optional-dependencies]
dev = ["pybispectra[doc]", "pybispectra[lint]", "pybispectra[test]"]
Expand Down
2 changes: 1 addition & 1 deletion src/pybispectra/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Initialisation of the PyBispectra package."""

__version__ = "1.2.0dev"
__version__ = "1.2.0"

from .cfc import AAC, PAC, PPC
from .data import get_example_data_paths
Expand Down
2 changes: 1 addition & 1 deletion src/pybispectra/cfc/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Tools for handling cross-frequency coupling analysis."""

__version__ = "1.2.0dev"
__version__ = "1.2.0"

from .aac import AAC
from .pac import PAC
Expand Down
2 changes: 1 addition & 1 deletion src/pybispectra/data/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Storage and tools for handling data files."""

__version__ = "1.2.0dev"
__version__ = "1.2.0"

from .example_data import DATASETS, get_example_data_paths
2 changes: 1 addition & 1 deletion src/pybispectra/general/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Tools for handling general bispectrum and threenorm computations."""

__version__ = "1.2.0dev"
__version__ = "1.2.0"

from .general import Bispectrum, Threenorm
2 changes: 1 addition & 1 deletion src/pybispectra/tde/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Tools for handling time delay estimation analysis."""

__version__ = "1.2.0dev"
__version__ = "1.2.0"

from .tde import TDE
2 changes: 1 addition & 1 deletion src/pybispectra/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Helper tools for processing and storing results."""

__version__ = "1.2.0dev"
__version__ = "1.2.0"

from .ged import SpatioSpectralFilter
from .results import ResultsCFC, ResultsGeneral, ResultsTDE, ResultsWaveShape
Expand Down
2 changes: 1 addition & 1 deletion src/pybispectra/waveshape/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Tools for handling waveshape analysis."""

__version__ = "1.2.0dev"
__version__ = "1.2.0"

from .waveshape import WaveShape

0 comments on commit e53cdc6

Please sign in to comment.