Skip to content

Commit

Permalink
Initial code
Browse files Browse the repository at this point in the history
  • Loading branch information
jpgill86 committed Jun 22, 2019
1 parent bd64c31 commit 68200f6
Show file tree
Hide file tree
Showing 26 changed files with 3,295 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Specific to this project
/neurotic/version.py
/neurotic/example/example-data/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down
47 changes: 47 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1 +1,48 @@
neurotic
========

*Curate, visualize, and annotate your behavioral ephys data using Python*

.. image:: https://img.shields.io/pypi/v/neurotic.svg
:target: https://pypi.org/project/neurotic/
:alt: PyPI project

.. image:: https://img.shields.io/badge/github-source_code-blue.svg
:target: https://github.com/jpgill86/neurotic
:alt: GitHub source code

Installation
------------

Because **neurotic** depends on some pre-release changes in a couple libraries,
pip cannot automatically fetch all dependencies during normal setup. The file
``requirements.txt`` is provided for installing the correct versions of
dependencies. Both **neurotic** and its dependencies can be installed using
these commands::

git clone https://github.com/jpgill86/neurotic
cd neurotic
pip install -r requirements.txt
pip install .

If you get an error while installing PyAV, try this::

conda install -c conda-forge av

and then attempt to install the dependencies in ``requirements.txt`` again.

Getting started
---------------

Launch the standalone app from the command line::

neurotic

A simple example is provided. Select the "example dataset", download the
associated data, and then click launch.

Questions and support
---------------------

Please post any questions, problems, comments, or suggestions in the `GitHub
issue tracker <https://github.com/jpgill86/neurotic/issues>`_.
12 changes: 12 additions & 0 deletions neurotic/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# -*- coding: utf-8 -*-
"""
Curate, visualize, and annotate your behavioral ephys data using Python
"""

from .version import version as __version__
from .version import git_revision as __git_revision__

from .datasets import *
from .gui import *
from .scripts import *
from .utils import *
8 changes: 8 additions & 0 deletions neurotic/__main__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# -*- coding: utf-8 -*-
"""
"""

from .scripts import launch_standalone

launch_standalone()
9 changes: 9 additions & 0 deletions neurotic/datasets/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# -*- coding: utf-8 -*-
"""
"""

from ..datasets.ftpauth import *
from ..datasets.download import *
from ..datasets.metadata import *
from ..datasets.data import *
Loading

0 comments on commit 68200f6

Please sign in to comment.