{"id":24840435,"url":"https://github.com/etiennecmb/tensorpac","last_synced_at":"2025-04-06T08:13:17.045Z","repository":{"id":48453101,"uuid":"93316276","full_name":"EtienneCmb/tensorpac","owner":"EtienneCmb","description":"Phase-Amplitude Coupling under Python","archived":false,"fork":false,"pushed_at":"2024-07-30T12:42:12.000Z","size":122558,"stargazers_count":106,"open_issues_count":9,"forks_count":29,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-30T07:08:23.364Z","etag":null,"topics":["amplitude","coupling","event-related","filtering","neuroscience","oscillations","pac","parallel-computing","phase","phase-amplitude-coupling","tensor"],"latest_commit_sha":null,"homepage":"https://etiennecmb.github.io/tensorpac/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/EtienneCmb.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-04T13:47:18.000Z","updated_at":"2025-03-25T08:01:48.000Z","dependencies_parsed_at":"2025-02-14T12:11:53.191Z","dependency_job_id":"d7f4477e-ec12-49c5-a3e2-f2073e4a7523","html_url":"https://github.com/EtienneCmb/tensorpac","commit_stats":{"total_commits":356,"total_committers":7,"mean_commits":"50.857142857142854","dds":0.0449438202247191,"last_synced_commit":"ac9058fd375d423757943810f613d63785fab85f"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EtienneCmb%2Ftensorpac","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EtienneCmb%2Ftensorpac/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EtienneCmb%2Ftensorpac/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EtienneCmb%2Ftensorpac/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EtienneCmb","download_url":"https://codeload.github.com/EtienneCmb/tensorpac/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247451665,"owners_count":20940944,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amplitude","coupling","event-related","filtering","neuroscience","oscillations","pac","parallel-computing","phase","phase-amplitude-coupling","tensor"],"created_at":"2025-01-31T06:56:47.625Z","updated_at":"2025-04-06T08:13:17.026Z","avatar_url":"https://github.com/EtienneCmb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=========\nTensorpac\n=========\n\n.. image:: https://github.com/EtienneCmb/tensorpac/workflows/Tensorpac/badge.svg\n    :target: https://github.com/EtienneCmb/tensorpac/workflows/Tensorpac\n\n.. image:: https://travis-ci.org/EtienneCmb/tensorpac.svg?branch=master\n    :target: https://travis-ci.org/EtienneCmb/tensorpac\n\n.. image:: https://circleci.com/gh/EtienneCmb/tensorpac/tree/master.svg?style=svg\n    :target: https://circleci.com/gh/EtienneCmb/tensorpac/tree/master\n\n.. image:: https://ci.appveyor.com/api/projects/status/0arxtw05583gc3e2/branch/master?svg=true\n    :target: https://ci.appveyor.com/project/EtienneCmb/tensorpac/branch/master\n\n.. image:: https://codecov.io/gh/EtienneCmb/tensorpac/branch/master/graph/badge.svg\n  :target: https://codecov.io/gh/EtienneCmb/tensorpac\n\n.. image:: https://badge.fury.io/py/tensorpac.svg\n    :target: https://badge.fury.io/py/tensorpac\n\n.. image:: https://pepy.tech/badge/tensorpac\n    :target: https://pepy.tech/project/tensorpac\n\n.. image:: https://badges.gitter.im/EtienneCmb/tensorpac.svg\n    :target: https://gitter.im/EtienneCmb/tensorpac?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\n\n.. image:: https://zenodo.org/badge/93316276.svg\n   :target: https://zenodo.org/badge/latestdoi/93316276\n\n\n.. figure::  https://github.com/EtienneCmb/tensorpac/blob/master/docs/source/picture/tp.png\n   :align:   center\n\nDescription\n-----------\n\nTensorpac is an Python open-source toolbox for computing Phase-Amplitude Coupling (PAC) using tensors and parallel computing for an efficient, and highly flexible modular implementation of PAC metrics both known and novel. Check out our `documentation \u003chttp://etiennecmb.github.io/tensorpac/\u003e`_  for details.\n\nInstallation\n------------\n\nTensorpac uses NumPy, SciPy and joblib for parallel computing. To get started, just open your terminal and run :\n\n\n.. code-block:: console\n\n    $ pip install tensorpac\n\nCode snippet \u0026 illustration\n---------------------------\n\n.. code-block:: python\n\n  from tensorpac import Pac\n  from tensorpac.signals import pac_signals_tort\n\n  # Dataset of signals artificially coupled between 10hz and 100hz :\n  n_epochs = 20   # number of trials\n  n_times = 4000  # number of time points\n  sf = 512.       # sampling frequency\n\n  # Create artificially coupled signals using Tort method :\n  data, time = pac_signals_tort(f_pha=10, f_amp=100, noise=2, n_epochs=n_epochs,\n                                dpha=10, damp=10, sf=sf, n_times=n_times)\n\n  # Define a Pac object\n  p = Pac(idpac=(6, 0, 0), f_pha='hres', f_amp='hres')\n  # Filter the data and extract pac\n  xpac = p.filterfit(sf, data)\n\n  # plot your Phase-Amplitude Coupling :\n  p.comodulogram(xpac.mean(-1), cmap='Spectral_r', plotas='contour', ncontours=5,\n                 title=r'10hz phase$\\Leftrightarrow$100Hz amplitude coupling',\n                 fz_title=14, fz_labels=13)\n\n  p.show()\n\n\n\n.. figure::  https://github.com/EtienneCmb/tensorpac/blob/master/docs/source/picture/readme.png\n   :align:   center\n\nCite Tensorpac\n--------------\n\nTensorpac software has been published in `PLoS Computational Biology \u003chttps://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1008302\u003e`_\n\nUse the following Bibtex entry to cite it :\n\n.. code-block:: latex\n\n    @article{combrisson_tensorpac_2020,\n        title = {Tensorpac: {An} open-source {Python} toolbox for tensor-based phase-amplitude coupling measurement in electrophysiological brain signals},\n        volume = {16},\n        issn = {1553-7358},\n        shorttitle = {Tensorpac},\n        doi = {10.1371/journal.pcbi.1008302},\n        language = {eng},\n        number = {10},\n        journal = {PLoS computational biology},\n        author = {Combrisson, Etienne and Nest, Timothy and Brovelli, Andrea and Ince, Robin A. A. and Soto, Juan L. P. and Guillot, Aymeric and Jerbi, Karim},\n        month = oct,\n        year = {2020},\n        pmid = {33119593},\n        pmcid = {PMC7654762},\n        pages = {e1008302},\n    }\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetiennecmb%2Ftensorpac","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fetiennecmb%2Ftensorpac","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fetiennecmb%2Ftensorpac/lists"}