| Name | esi-syncopy JSON |
| Version |
2023.9
JSON |
| download |
| home_page | https://syncopy.org |
| Summary | A toolkit for user-friendly large-scale electrophysiology data analysis. Syncopy is compatible with the Matlab toolbox FieldTrip. |
| upload_time | 2023-09-25 11:12:36 |
| maintainer | |
| docs_url | None |
| author | Stefan Fürtinger |
| requires_python | >=3.8,<3.12 |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
.. image:: https://raw.githubusercontent.com/esi-neuroscience/syncopy/master/doc/source/_static/syncopy_logo_small.png
:alt: Syncopy-Logo
Systems Neuroscience Computing in Python
========================================
|Conda Version| |PyPi Version| |License| |DOI|
.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/esi-syncopy.svg
:target: https://anaconda.org/conda-forge/esi-syncopy
.. |PyPI version| image:: https://badge.fury.io/py/esi-syncopy.svg
:target: https://badge.fury.io/py/esi-syncopy
.. |License| image:: https://img.shields.io/github/license/esi-neuroscience/syncopy
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8191941.svg
:target: https://doi.org/10.5281/zenodo.8191941
|Master Tests| |Master Coverage|
.. |Master Tests| image:: https://github.com/esi-neuroscience/syncopy/actions/workflows/cov_test_workflow.yml/badge.svg?branch=master
:target: https://github.com/esi-neuroscience/syncopy/actions/workflows/cov_test_workflow.yml
.. |Master Coverage| image:: https://codecov.io/gh/esi-neuroscience/syncopy/branch/master/graph/badge.svg?token=JEI3QQGNBQ
:target: https://codecov.io/gh/esi-neuroscience/syncopy
Syncopy aims to be a user-friendly toolkit for *large-scale*
electrophysiology data-analysis in Python. We strive to achieve the following goals:
1. Syncopy is a *fully open source Python* environment for electrophysiology
data analysis.
2. Syncopy is *scalable* and built for *very large datasets*. It automatically
makes use of available computing resources and is developed with built-in
parallelism in mind.
3. Syncopy is *compatible with FieldTrip*. Data and results can be loaded into
MATLAB and Python, and parameter names and function call syntax are as similar as possible.
Syncopy is developed at the
`Ernst Strüngmann Institute (ESI) gGmbH for Neuroscience in Cooperation with Max Planck Society <https://www.esi-frankfurt.de/>`_
and released free of charge under the
`BSD 3-Clause "New" or "Revised" License <https://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_(%22BSD_License_2.0%22,_%22Revised_BSD_License%22,_%22New_BSD_License%22,_or_%22Modified_BSD_License%22)>`_.
Contact
-------
To report bugs or ask questions please use our `GitHub issue tracker <https://github.com/esi-neuroscience/syncopy/issues>`_.
For general inquiries please contact syncopy (at) esi-frankfurt.de.
Installation
============
We recommend to install SynCoPy into a new conda environment:
#. Install the `Anaconda Distribution for your Operating System <https://www.anaconda.com/products/distribution>`_ if you do not yet have it.
#. Start a new terminal.
* You can do this by starting ```Anaconda navigator```, selecting ```Environments``` in the left tab, selecting the ```base (root)``` environment, and clicking the green play button and then ```Open Terminal```.
* Alternatively, under Linux, you can just type ```bash``` in your active terminal to start a new session.
You should see a terminal with a command prompt that starts with ```(base)```, indicating that you are
in the conda ```base``` environment.
Now we create a new environment named ```syncopy``` and install syncopy into this environment:
.. code-block:: bash
conda create -y --name syncopy
conda activate syncopy
conda install -y -c conda-forge esi-syncopy
Getting Started
===============
Please visit our `online documentation <http://syncopy.org>`_.
Developer Installation
-----------------------
To get the latest development version, please clone our GitHub repository and change to the `dev` branch. We highly recommend to install into a new conda virtual environment, so that this development version does not interfere with your existing installation.
.. code-block:: bash
git clone https://github.com/esi-neuroscience/syncopy.git
cd syncopy/
conda env create --name syncopy-dev --file syncopy.yml
conda activate syncopy-dev
pip install -e .
We recommend to verify your development installation by running the unit tests. You can skip the parallel tests to save some time, the tests should run in about 5 minutes then:
.. code-block:: bash
python -m pytest -k "not parallel"
You now have a verified developer installation of Syncopy. Please refert to our `contributing guide <https://github.com/esi-neuroscience/syncopy/blob/master/CONTRIBUTING.md>`_ if you want to contribute to Syncopy.
Raw data
{
"_id": null,
"home_page": "https://syncopy.org",
"name": "esi-syncopy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "Stefan F\u00fcrtinger",
"author_email": "sfuerti@esi-frankfurt.de",
"download_url": "https://files.pythonhosted.org/packages/db/59/727459737f4893c4c68cd0d734c0a08da5d3270b36f400d4aeef72cf9def/esi_syncopy-2023.9.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/esi-neuroscience/syncopy/master/doc/source/_static/syncopy_logo_small.png\n\t :alt: Syncopy-Logo\n\nSystems Neuroscience Computing in Python\n========================================\n\n\n|Conda Version| |PyPi Version| |License| |DOI|\n\n.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/esi-syncopy.svg\n :target: https://anaconda.org/conda-forge/esi-syncopy\n.. |PyPI version| image:: https://badge.fury.io/py/esi-syncopy.svg\n :target: https://badge.fury.io/py/esi-syncopy\n.. |License| image:: https://img.shields.io/github/license/esi-neuroscience/syncopy\n.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8191941.svg\n :target: https://doi.org/10.5281/zenodo.8191941\n\n|Master Tests| |Master Coverage|\n\n.. |Master Tests| image:: https://github.com/esi-neuroscience/syncopy/actions/workflows/cov_test_workflow.yml/badge.svg?branch=master\n :target: https://github.com/esi-neuroscience/syncopy/actions/workflows/cov_test_workflow.yml\n.. |Master Coverage| image:: https://codecov.io/gh/esi-neuroscience/syncopy/branch/master/graph/badge.svg?token=JEI3QQGNBQ\n :target: https://codecov.io/gh/esi-neuroscience/syncopy\n\nSyncopy aims to be a user-friendly toolkit for *large-scale*\nelectrophysiology data-analysis in Python. We strive to achieve the following goals:\n\n1. Syncopy is a *fully open source Python* environment for electrophysiology\n data analysis.\n2. Syncopy is *scalable* and built for *very large datasets*. It automatically\n makes use of available computing resources and is developed with built-in\n parallelism in mind.\n3. Syncopy is *compatible with FieldTrip*. Data and results can be loaded into\n MATLAB and Python, and parameter names and function call syntax are as similar as possible.\n\nSyncopy is developed at the\n`Ernst Str\u00fcngmann Institute (ESI) gGmbH for Neuroscience in Cooperation with Max Planck Society <https://www.esi-frankfurt.de/>`_\nand released free of charge under the\n`BSD 3-Clause \"New\" or \"Revised\" License <https://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_(%22BSD_License_2.0%22,_%22Revised_BSD_License%22,_%22New_BSD_License%22,_or_%22Modified_BSD_License%22)>`_.\n\nContact\n-------\nTo report bugs or ask questions please use our `GitHub issue tracker <https://github.com/esi-neuroscience/syncopy/issues>`_.\nFor general inquiries please contact syncopy (at) esi-frankfurt.de.\n\nInstallation\n============\n\nWe recommend to install SynCoPy into a new conda environment:\n\n#. Install the `Anaconda Distribution for your Operating System <https://www.anaconda.com/products/distribution>`_ if you do not yet have it.\n#. Start a new terminal.\n\n * You can do this by starting ```Anaconda navigator```, selecting ```Environments``` in the left tab, selecting the ```base (root)``` environment, and clicking the green play button and then ```Open Terminal```.\n * Alternatively, under Linux, you can just type ```bash``` in your active terminal to start a new session.\n\nYou should see a terminal with a command prompt that starts with ```(base)```, indicating that you are\nin the conda ```base``` environment.\n\nNow we create a new environment named ```syncopy``` and install syncopy into this environment:\n\n.. code-block:: bash\n\n conda create -y --name syncopy\n conda activate syncopy\n conda install -y -c conda-forge esi-syncopy\n\nGetting Started\n===============\nPlease visit our `online documentation <http://syncopy.org>`_.\n\nDeveloper Installation\n-----------------------\n\nTo get the latest development version, please clone our GitHub repository and change to the `dev` branch. We highly recommend to install into a new conda virtual environment, so that this development version does not interfere with your existing installation.\n\n.. code-block:: bash\n\n git clone https://github.com/esi-neuroscience/syncopy.git\n cd syncopy/\n conda env create --name syncopy-dev --file syncopy.yml\n conda activate syncopy-dev\n pip install -e .\n\n\nWe recommend to verify your development installation by running the unit tests. You can skip the parallel tests to save some time, the tests should run in about 5 minutes then:\n\n\n.. code-block:: bash\n\n python -m pytest -k \"not parallel\"\n\n\nYou now have a verified developer installation of Syncopy. Please refert to our `contributing guide <https://github.com/esi-neuroscience/syncopy/blob/master/CONTRIBUTING.md>`_ if you want to contribute to Syncopy.\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A toolkit for user-friendly large-scale electrophysiology data analysis. Syncopy is compatible with the Matlab toolbox FieldTrip.",
"version": "2023.9",
"project_urls": {
"Homepage": "https://syncopy.org",
"Repository": "https://github.com/esi-neuroscience/syncopy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31500f9df45da44d19626d9a108c42d4cae1bfa1bf4b825076ddd50d6035744e",
"md5": "e4dc936d54a6a0f62115750710b10429",
"sha256": "bd544a71804403080cc6c0f626aa79a6e4d72f54fe664a1bf710cf462277af9b"
},
"downloads": -1,
"filename": "esi_syncopy-2023.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4dc936d54a6a0f62115750710b10429",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 447608,
"upload_time": "2023-09-25T11:12:33",
"upload_time_iso_8601": "2023-09-25T11:12:33.112284Z",
"url": "https://files.pythonhosted.org/packages/31/50/0f9df45da44d19626d9a108c42d4cae1bfa1bf4b825076ddd50d6035744e/esi_syncopy-2023.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db59727459737f4893c4c68cd0d734c0a08da5d3270b36f400d4aeef72cf9def",
"md5": "ae8a94431c3d8b5e27dbb027be56da64",
"sha256": "a74b19c54310340b515cc89261ff072c65b748a6476e1ce7eafb61a21e124b24"
},
"downloads": -1,
"filename": "esi_syncopy-2023.9.tar.gz",
"has_sig": false,
"md5_digest": "ae8a94431c3d8b5e27dbb027be56da64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 373358,
"upload_time": "2023-09-25T11:12:36",
"upload_time_iso_8601": "2023-09-25T11:12:36.803309Z",
"url": "https://files.pythonhosted.org/packages/db/59/727459737f4893c4c68cd0d734c0a08da5d3270b36f400d4aeef72cf9def/esi_syncopy-2023.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 11:12:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "esi-neuroscience",
"github_project": "syncopy",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "esi-syncopy"
}
