Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.35 KB

api.rst

File metadata and controls

58 lines (40 loc) · 1.35 KB
Raw

API Reference Guide

In addition to using neurotic as a standalone app, you can also leverage its API in your own code.

Note

TL;DR: The easiest way to use neurotic in an interactive session or script is by invoking neurotic.quick_launch() <neurotic.scripts.quick_launch>. For example:

>>> metadata = {'data_file': 'data.axgx'} >>> neurotic.quick_launch(metadata=metadata)

or

>>> neurotic.quick_launch(blk=my_neo_block)

The core of the API consists of two classes and one function:

  • neurotic.datasets.metadata.MetadataSelector: Read metadata files, download datasets
  • neurotic.datasets.data.load_dataset: Read datasets, apply filters and spike detection
  • neurotic.gui.config.EphyviewerConfigurator: Launch ephyviewer

All public package contents are automatically imported directly into the neurotic namespace. This means that a class like neurotic.datasets.metadata.MetadataSelector can be accessed more compactly as neurotic.MetadataSelector.

api/data api/download api/ftpauth api/metadata

api/config api/epochencoder api/notebook api/standalone

api/scripts api/_elephant_tools