Metadata-Version: 2.1
Name: spyglass-neuro
Version: 0.4.0a1
Summary: Neuroscience data analysis framework for reproducible research
Project-URL: Homepage, https://github.com/LorenFrankLab/spyglass
Project-URL: Bug Tracker, https://github.com/LorenFrankLab/spyglass/issues
Author-email: Loren Frank <loren.frank@ucsf.edu>, Kyu Hyun Lee <kyuhyun.lee@ucsf.edu>, Eric Denovellis <eric.denovellis@ucsf.edu>, Ryan Ly <rly@lbl.gov>, Daniel Gramling <daniel.gramling@ucsf.edu>, Chris Brozdowski <chris.broz@ucsf.edu>
License: Copyright (c) 2020-present Loren Frank
        
        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 BEsq 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.
License-File: LICENSE
Keywords: data analysis,datajoint,electrophysiology,kachery,neuroscience,nwb,reproducible,research,sortingview,spike sorting,spikeinterface
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: <3.10,>=3.9
Requires-Dist: bottleneck
Requires-Dist: click
Requires-Dist: dask
Requires-Dist: datajoint>=0.13.6
Requires-Dist: hdmf>=3.4.6
Requires-Dist: ipympl
Requires-Dist: matplotlib
Requires-Dist: ndx-franklab-novela>=0.1.0
Requires-Dist: numpy<1.24
Requires-Dist: position-tools
Requires-Dist: pubnub<6.4.0
Requires-Dist: pydotplus
Requires-Dist: pymysql
Requires-Dist: pynwb<3,>=2.2.0
Requires-Dist: pyyaml
Requires-Dist: replay-trajectory-classification
Requires-Dist: ripple-detection
Requires-Dist: seaborn
Requires-Dist: sortingview>=0.11
Requires-Dist: spikeinterface
Requires-Dist: tqdm
Requires-Dist: track-linearization>=2.3
Requires-Dist: trajectory-analysis-tools
Provides-Extra: docs
Requires-Dist: hatch; extra == 'docs'
Requires-Dist: mike; extra == 'docs'
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-exclude; extra == 'docs'
Requires-Dist: mkdocs-exclude-search; extra == 'docs'
Requires-Dist: mkdocs-gen-files; extra == 'docs'
Requires-Dist: mkdocs-jupyter; extra == 'docs'
Requires-Dist: mkdocs-literate-nav; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Provides-Extra: position
Requires-Dist: deeplabcut<2.3.0; extra == 'position'
Requires-Dist: ffmpeg; extra == 'position'
Requires-Dist: numba>=0.54; extra == 'position'
Provides-Extra: test
Requires-Dist: kachery; extra == 'test'
Requires-Dist: kachery-client; extra == 'test'
Requires-Dist: kachery-cloud; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# spyglass

[![Import test](https://github.com/LorenFrankLab/spyglass/actions/workflows/workflow.yml/badge.svg)](https://github.com/LorenFrankLab/spyglass/actions/workflows/workflow.yml)

`spyglass` is a data analysis framework that facilitates the storage, analysis,
visualization, and sharing of neuroscience data to support reproducible
research. It is designed to be interoperable with the NWB format and integrates
open-source tools into a coherent framework.

Documentation can be found at -
[https://lorenfranklab.github.io/spyglass/](https://lorenfranklab.github.io/spyglass/)

## Installation

For installation instructions see -
[https://lorenfranklab.github.io/spyglass/latest/installation/](https://lorenfranklab.github.io/spyglass/latest/installation/)

## Tutorials

The tutorials for `spyglass` is currently in the form of Jupyter Notebooks and
can be found in the
[notebooks](https://github.com/LorenFrankLab/spyglass/tree/master/notebooks)
directory. We strongly recommend opening them in the context of `jupyterlab`.

## Contributing

See the [Developer's Note](https://lorenfranklab.github.io/spyglass/latest/contribute/)
for contributing instructions found at -
[https://lorenfranklab.github.io/spyglass/latest/contribute/](https://lorenfranklab.github.io/spyglass/latest/contribute/)

## License/Copyright

License and Copyright notice can be found at
[https://lorenfranklab.github.io/spyglass/latest/LICENSE/](https://lorenfranklab.github.io/spyglass/latest/LICENSE/)

## Citation

Kyu Hyun Lee, Eric Denovellis, Ryan Ly, Jeremy Magland, Jeff Soules, Alison
Comrie, Jennifer Guidera, Rhino Nevers, Daniel Gramling, Philip Adenekan, Ji
Hyun Bak, Emily Monroe, Andrew Tritt, Oliver Rübel, Thinh Nguyen, Dimitri
Yatsenko, Joshua Chu, Caleb Kemere, Samuel Garcia, Alessio Buccino, Emily Aery
Jones, Lisa Giocomo, and Loren Frank. Spyglass: A Data Analysis Framework for
Reproducible and Shareable Neuroscience Research. Neuroscience Meeting Planner.
San Diego, CA: Society for Neuroscience, 2022.
