.. _v1.0.0:

neurotic 1.0.0
==============

2019-07-27

🎊 First stable release! 🎉

Improvements
------------

* Major API changes
  (:pr:`104`, :pr:`100`, :pr:`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 <https://neurotic.readthedocs.io/en/latest/api.html>`__

* Add example Jupyter notebook and command line argument for launching it
  (:pr:`108`)

* Add file overwrite option to download functions
  (:pr:`106`)

* Reserve the metadata keyword ``neurotic_config`` for global parameters
  (:pr:`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
  (:pr:`97`)

* Allow amplitude discriminators to be specified with arbitrary units
  (:pr:`99`)