1.5.0

1.5.0 (2021-01-17)

Installing neurotic | Updating neurotic | Documentation

This release’s biggest feature is Google Drive integration: Use neurotic to fetch data files from either My Drive or Share Drives (formerly known as Team Drives). Read more here: URLs to Use with Google Drive and Configuring for Google Drive.

Additionally, you can now customize some default settings for neurotic, such as which metadata file is opened by default. Read more here: Changing Default Behavior.

New features

• Add capability to download files from Google Drive (#294, #297, #309)
• Allow users to change defaults in a global configuration file (#285, #304)

Improvements

• Automatically check for updates when the app is launched (#307, #310)
• Remove incomplete files when a download is interrupted (#280)
• Add amplitude discriminator parameter for extrema type (detect peaks or troughs) (#284)
• Annotate detected spike trains with amplitude discriminator units and epoch (#281, #282, #284)

Documentation

• Many aesthetic and content improvements to the documentation (#256, #268, #269, #272, #273, #274, #275, #295, #298, #302, #303, #305, #306, #308)

Testing

• Transition to GitHub Actions for automated testing (#286, #287, #299, #301)
• Add tests for and declare support for Python 3.9 (#283)
• Exclude py files not part of the main package from coverage reports (#300)

1.4.1

1.4.1 (2020-03-15)

Installing neurotic | Updating neurotic | Documentation

Improvements

• Add neurotic_version parameter to metadata (#247)
• Revised and added new example datasets (#250, #251)

Bug fixes

• Fix broken import of Neo’s generate_one_simple_block in example notebook (#253)
• Fix default font size determination in scripts and Jupyter notebooks (#249)

Other changes

• Make “large” UI scale larger and “huge” UI scale huger (#244)
• Scale loading message with other fonts (#245)
• Address numpy FutureWarning when epoch list is empty (#248)

Documentation

• Add project acronym to package description, app, and docs (#252)
• Building of standalone installers is now automated (#254)

1.4.0

1.4.0 (2020-03-04)

Installing neurotic | Updating neurotic | Documentation

New features

• Add computation of smoothed firing rates for spike trains (#189)
• Add quick_launch function for easier scripting and interactive sessions (#191, #196)
• Add blk param to load_dataset for using existing Neo Block (#196)
• Add rec_datetime metadata parameter for setting real-world start time (#190)
• Add past_fraction metadata parameter for controlling the placement of the vertical line marking the current time (#220)
• Add color options for signal plots to metadata (#177)
• Add options for scaling the user interface (#222, #241, #242)
• Add launch via double click in standalone app (#218)

Help & feedback

• Display loading indicator when launching in the standalone app (#223)
• Prompt the user to reload metadata after using the menu to edit metadata (#226)
• Show “Downloads complete” in app status bar and in log (#219)
• Add menu action status tips to standalone app (#221, #240)
• Add “Check for updates” to help menu (#201)
• Add Help menu actions for opening common URLs (#198, #230)
• Add Python version and neurotic install path to About window (#181)
• Display common error messages to status bar in standalone app (#225)
• Display a splash screen when first starting the standalone app (#224)

Jupyter tutorial

Start the tutorial using neurotic --launch-example-notebook or view it here.

• Add API tutorial to example Jupyter notebook (#234, #236)
• Add shell commands to example Jupyter notebook for installing neurotic (#185)

Other changes

• Move RAUC calculations to load_dataset and store them as annotations (#188)
• Disable RAUC calculations by default (#193)
• Allow data_file to be unspecified in metadata and signals to be optional (#195)
• Ignore video_file if PyAV is not installed (#231)
• Rename elephant functions (#183)

Bug fixes

• Fix crash when plots list is empty (#217)
• Fix plotted signal sampling rate and start time if units are not Hz and sec, respectively (#194)
• Fix incompatibility with old versions of tqdm and unknown download size (#184)

Documentation

• Improve documentation for installation and updating (#180, #229)

Logging

• Add package logger and permanent log file (#174)
• Log fatal errors in standalone app instead of crashing (#176)
• Add CLI and GUI options for enabling debug log messages (#178)
• Raise the default threshold for PyAV messages from warning to critical (#179)

1.3.0

1.3.0 (2020-01-07)

Improvements

• Add burst detection via firing rate thresholding (#156)
• Add button for auto-scaling signals to main window (#150)
• Add metadata color parameters for amplitude_discriminators (#166)
• Add metadata parameters rauc_baseline and rauc_bin_duration (#151)
• Make data_dir default to metadata file directory (#163)

Bug fixes

• Unmask FileNotFoundError when local data file is missing (#154)

Documentation

• Add Zenodo archive badge (#162)

1.2.1

1.2.1 (2019-12-09)

Bug fixes

• Fix loading using Neo IOs lacking signals_group_mode (TypeError: read_block() got an unexpected keyword argument 'signal_group_mode') (#143)

1.2.0

1.2.0 (2019-12-06)

neurotic should now have broader compatibility with file types supported by Neo’s neo.io classes thanks to two new metadata parameters: io_class and io_args. See Data Reader (Neo) Settings for details.

neurotic is now available on conda-forge! See Recommended Method for details on how to install.

Improvements

• Add metadata parameters io_class and io_args (#137)

Documentation

• Add conda-forge installation instructions (#128)

1.1.1

1.1.1 (2019-10-17)

Changes

• Remove elephant as a dependency (#120)

1.1.0

1.1.0 (2019-10-09)

Improvements

• Add API parameters and CLI argument for displaying the real-world date and time (potentially inaccurate) (#110, #118)
• Add printer-friendly theme (white background) (#114)

Documentation

• Add documentation of GIN URLs for public and private repos (#113)

1.0.0

1.0.0 (2019-07-27)

🎊 First stable release! 🎉

Improvements

• Major API changes (#104, #100, #106)
  • In preparation for this stable release, many formerly public classes and functions were made private. This was done to minimize the number of public classes/functions, which beginning with this release will be treated as stable APIs that are ideally modified only in backwards compatible ways. Users should trust that public classes and functions will not be changed without good reason and a major version bump.
• Many improvements to the documentation, including the addition of an API Reference Guide
• Add example Jupyter notebook and command line argument for launching it (#108)
• Add file overwrite option to download functions (#106)
• Reserve the metadata keyword neurotic_config for global parameters (#93)
  • The remote_data_root key must now be nested under neurotic_config.

Bug fixes

• Fix crash when epoch encoder file contains labels not listed in metadata (#97)
• Allow amplitude discriminators to be specified with arbitrary units (#99)

0.7.0

0.7.0 (2019-07-21)

Improvements

• New documentation hosted at Read the Docs: https://neurotic.readthedocs.io
• Add menu action for opening metadata in editor (#83)
• Add menu action for opening the selected data directory (#84)
• Add list of installed versions of dependencies and doc links to About window (#44, #65)

Bug fixes

• Fix files remaining locked after closing a fast-loaded window (#69)
• Fix launching from command line with bad metadata argument (#82)