API Reference GuideΒΆ

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


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

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


>>> neurotic.quick_launch(blk=my_neo_block)

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

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.