CalSciPy


NameCalSciPy JSON
Version 0.8.3 PyPI version JSON
download
home_pageNone
SummaryA toolbox for analyzing, designing, and visualizing multiphoton imaging & optogenetics experiments.
upload_time2024-03-27 17:45:37
maintainerDarik A. O'Neil
docs_urlNone
authorDarik A. O'Neil
requires_python<4,>=3.8
licenseMIT License Copyright (c) 2023 Darik A O’Neil Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords calscipy calcium imaging
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Alt text](/docs/images/dancing_neuron_band.png?raw=true)


## CalSciPy      
<!-- Line 1 Badges... PyPi, Downloads, Maintained, Coverage, Documentation -->
<!-- Line 2 Badges... Python Versions, PyPi Status, License, Contributors -->
![PyPI](https://img.shields.io/pypi/v/CalSciPy)
![Maintenance](https://img.shields.io/maintenance/yes/2023)
[![Coverage Status](https://coveralls.io/repos/github/darikoneil/CalSciPy/badge.svg?branch=master)](https://coveralls.io/github/darikoneil/CalSciPy?branch=master)
[![Documentation Status](https://readthedocs.org/projects/calscipy/badge/?version=latest)](https://calscipy.readthedocs.io/en/latest/?badge=latest)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/CalSciPy?)
![PyPI - Status](https://img.shields.io/pypi/status/CalSciPy)
![GitHub](https://img.shields.io/github/license/darikoneil/CalSciPy)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/darikoneil/CalSciPy/calscipy_lint_test_action.yml)

CalSciPy is a utility toolbox for calcium imaging experiments. It contains a variety of useful features, from 
interactive visualization of data to computer-generated holography for "read/write" experiments, and 
everything in-between. Essentially, it's a collection of code written for my imaging experiments that might be 
considered useful to others. I was inspired to upload my own code to solve some of the issues outlined in the [motivation](https://calscipy.readthedocs.io/en/latest/introduction__motivation.html) section of the [docs](https://calscipy.readthedocs.io/en/latest/index.html#) or at least create a neat package my friends and I could use to easily analyze data across various environments and computers.

#### Active Development
As of version 0.9.8, the current implementation is unstable, partially untested, partially finished, and should be considered an open alpha/beta. ***Please be patient, refactoring my code for public use is a pet-project. I have to graduate at some point and I have a newborn.***

Until things are more stable, I'll explicitly note which subpackages are stable, have >90% test coverage, and are ready-to-use.

#### Stable & Tested Modules
* The main module is ready to use as of 0.7.5. New features will be demarcated by a label indicating the version added in the docs.
#### Experimental
* The organization module is untested but incorporated into the distributed pypi version
* The bruker module is untested but incorporated into the distributed pypi version
* The optogenetics module is untested but incorporated into the distributed pypi version
  
#### Unstable
* The interactive module is unstable but partially incorporated into the distributed pypi version
* The optics module is unstable and not incorporated into the distributed pypi version
  
#### Installation
Eventually I will break things up into sub-packages so you don't have to install everything together...         
`pip install CalSciPy`

#### Roadmap
My current focus is on refactoring tools for holographic optogenetics and circumventing PrairieView's writing of data to proprietary RAW format. I also plan on
breaking up this repo because its many of its contents are too decoupled (e.g., bruker prairieview tricks / helpers vs experiment organization)

#### Contributions
Save me from myself, contributions welcome :)

#### Documentation
Hosted at [ReadtheDocs](https://calscipy.readthedocs.io/en/latest/index.html#).
Available locally as [HTML](https://github.com/darikoneil/CalSciPy/tree/master/docs/build/html), [LATEX](https://github.com/darikoneil/CalSciPy/tree/master/docs/build/latex) and [PDF](https://github.com/darikoneil/CalSciPy/blob/master/docs/build/pdf/calscipy.pdf).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "CalSciPy",
    "maintainer": "Darik A. O'Neil",
    "docs_url": null,
    "requires_python": "<4,>=3.8",
    "maintainer_email": null,
    "keywords": "CalSciPy, Calcium Imaging",
    "author": "Darik A. O'Neil",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a7/c6/e084ff5e59e40b5f38b883cce50d01f112de2f81d692026d5a95f9b8b365/CalSciPy-0.8.3.tar.gz",
    "platform": null,
    "description": "![Alt text](/docs/images/dancing_neuron_band.png?raw=true)\r\n\r\n\r\n## CalSciPy      \r\n<!-- Line 1 Badges... PyPi, Downloads, Maintained, Coverage, Documentation -->\r\n<!-- Line 2 Badges... Python Versions, PyPi Status, License, Contributors -->\r\n![PyPI](https://img.shields.io/pypi/v/CalSciPy)\r\n![Maintenance](https://img.shields.io/maintenance/yes/2023)\r\n[![Coverage Status](https://coveralls.io/repos/github/darikoneil/CalSciPy/badge.svg?branch=master)](https://coveralls.io/github/darikoneil/CalSciPy?branch=master)\r\n[![Documentation Status](https://readthedocs.org/projects/calscipy/badge/?version=latest)](https://calscipy.readthedocs.io/en/latest/?badge=latest)\r\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/CalSciPy?)\r\n![PyPI - Status](https://img.shields.io/pypi/status/CalSciPy)\r\n![GitHub](https://img.shields.io/github/license/darikoneil/CalSciPy)\r\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/darikoneil/CalSciPy/calscipy_lint_test_action.yml)\r\n\r\nCalSciPy is a utility toolbox for calcium imaging experiments. It contains a variety of useful features, from \r\ninteractive visualization of data to computer-generated holography for \"read/write\" experiments, and \r\neverything in-between. Essentially, it's a collection of code written for my imaging experiments that might be \r\nconsidered useful to others. I was inspired to upload my own code to solve some of the issues outlined in the [motivation](https://calscipy.readthedocs.io/en/latest/introduction__motivation.html) section of the [docs](https://calscipy.readthedocs.io/en/latest/index.html#) or at least create a neat package my friends and I could use to easily analyze data across various environments and computers.\r\n\r\n#### Active Development\r\nAs of version 0.9.8, the current implementation is unstable, partially untested, partially finished, and should be considered an open alpha/beta. ***Please be patient, refactoring my code for public use is a pet-project. I have to graduate at some point and I have a newborn.***\r\n\r\nUntil things are more stable, I'll explicitly note which subpackages are stable, have >90% test coverage, and are ready-to-use.\r\n\r\n#### Stable & Tested Modules\r\n* The main module is ready to use as of 0.7.5. New features will be demarcated by a label indicating the version added in the docs.\r\n#### Experimental\r\n* The organization module is untested but incorporated into the distributed pypi version\r\n* The bruker module is untested but incorporated into the distributed pypi version\r\n* The optogenetics module is untested but incorporated into the distributed pypi version\r\n  \r\n#### Unstable\r\n* The interactive module is unstable but partially incorporated into the distributed pypi version\r\n* The optics module is unstable and not incorporated into the distributed pypi version\r\n  \r\n#### Installation\r\nEventually I will break things up into sub-packages so you don't have to install everything together...         \r\n`pip install CalSciPy`\r\n\r\n#### Roadmap\r\nMy current focus is on refactoring tools for holographic optogenetics and circumventing PrairieView's writing of data to proprietary RAW format. I also plan on\r\nbreaking up this repo because its many of its contents are too decoupled (e.g., bruker prairieview tricks / helpers vs experiment organization)\r\n\r\n#### Contributions\r\nSave me from myself, contributions welcome :)\r\n\r\n#### Documentation\r\nHosted at [ReadtheDocs](https://calscipy.readthedocs.io/en/latest/index.html#).\r\nAvailable locally as [HTML](https://github.com/darikoneil/CalSciPy/tree/master/docs/build/html), [LATEX](https://github.com/darikoneil/CalSciPy/tree/master/docs/build/latex) and [PDF](https://github.com/darikoneil/CalSciPy/blob/master/docs/build/pdf/calscipy.pdf).\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Darik A O\u2019Neil  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A toolbox for analyzing, designing, and visualizing multiphoton imaging & optogenetics experiments.",
    "version": "0.8.3",
    "project_urls": {
        "documentation": "https://calscipy.readthedocs.io/en/latest/?badge=latest",
        "repository": "https://github.com/darikoneil/CalSciPy"
    },
    "split_keywords": [
        "calscipy",
        " calcium imaging"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7f44123257327cacfc9e164b5cbc04d4adb68f157ab9b46df8428eb9be2b1598",
                "md5": "c48e60654dacbe984a332d4d9b605bf6",
                "sha256": "05b81f39c22e4ddc6722281dc9d3f73f38ce045de08126f5b449968d98d79145"
            },
            "downloads": -1,
            "filename": "CalSciPy-0.8.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c48e60654dacbe984a332d4d9b605bf6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.8",
            "size": 104458,
            "upload_time": "2024-03-27T17:45:36",
            "upload_time_iso_8601": "2024-03-27T17:45:36.092572Z",
            "url": "https://files.pythonhosted.org/packages/7f/44/123257327cacfc9e164b5cbc04d4adb68f157ab9b46df8428eb9be2b1598/CalSciPy-0.8.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a7c6e084ff5e59e40b5f38b883cce50d01f112de2f81d692026d5a95f9b8b365",
                "md5": "c571798f2d5c8dc2939b0d3ec3cc698d",
                "sha256": "5406316b4d697a08e872f198f8d05fb388d15b9f4f08bda4a8d0bdd20c939d6f"
            },
            "downloads": -1,
            "filename": "CalSciPy-0.8.3.tar.gz",
            "has_sig": false,
            "md5_digest": "c571798f2d5c8dc2939b0d3ec3cc698d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.8",
            "size": 93290,
            "upload_time": "2024-03-27T17:45:37",
            "upload_time_iso_8601": "2024-03-27T17:45:37.779022Z",
            "url": "https://files.pythonhosted.org/packages/a7/c6/e084ff5e59e40b5f38b883cce50d01f112de2f81d692026d5a95f9b8b365/CalSciPy-0.8.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 17:45:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "darikoneil",
    "github_project": "CalSciPy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "calscipy"
}
        
Elapsed time: 9.60122s