-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Many, many formerly public classes and functions are now private. This is done to minimize the number of public classes/functions, which after release should be treated as stable APIs that are ideally modified only in backwards compatible ways. Of those that remain public, some were renamed: * ``LoadAndPrepareData`` --> ``load_dataset`` * ``setup`` --> ``setup_ftpauth`` * ``MyWritableEpochSource`` --> ``NeuroticWritableEpochSource`` * ``DataExplorer`` --> ``MainWindow``
- Loading branch information
Showing
23 changed files
with
934 additions
and
773 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
.. _api: | ||
|
||
API Reference | ||
============= | ||
|
||
In addition to using **neurotic** as a standalone app, you can also leverage | ||
its API in your own code. | ||
|
||
The core of the API consists of two classes and one function: | ||
|
||
* :class:`neurotic.datasets.metadata.MetadataSelector`: Read metadata files, download datasets | ||
* :func:`neurotic.datasets.data.load_dataset`: Read datasets, apply filters and spike detection | ||
* :class:`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``. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Datasets | ||
|
||
api/data | ||
api/download | ||
api/ftpauth | ||
api/metadata | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: GUI | ||
|
||
api/config | ||
api/epochencoder | ||
api/notebook | ||
api/standalone |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-config: | ||
|
||
``neurotic.gui.config`` | ||
======================= | ||
|
||
.. automodule:: neurotic.gui.config |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-data: | ||
|
||
``neurotic.datasets.data`` | ||
========================== | ||
|
||
.. automodule:: neurotic.datasets.data |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-download: | ||
|
||
``neurotic.datasets.download`` | ||
============================== | ||
|
||
.. automodule:: neurotic.datasets.download |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-epochencoder: | ||
|
||
``neurotic.gui.epochencoder`` | ||
============================= | ||
|
||
.. automodule:: neurotic.gui.epochencoder |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-ftpauth: | ||
|
||
``neurotic.datasets.ftpauth`` | ||
============================= | ||
|
||
.. automodule:: neurotic.datasets.ftpauth |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-metadata: | ||
|
||
``neurotic.datasets.metadata`` | ||
============================== | ||
|
||
.. automodule:: neurotic.datasets.metadata |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-notebook: | ||
|
||
``neurotic.gui.notebook`` | ||
========================= | ||
|
||
.. automodule:: neurotic.gui.notebook |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.. _api-standalone: | ||
|
||
``neurotic.gui.standalone`` | ||
=========================== | ||
|
||
.. automodule:: neurotic.gui.standalone |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.