diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst index ce6fc0a..b3f63a8 100644 --- a/docs/releasenotes.rst +++ b/docs/releasenotes.rst @@ -6,6 +6,7 @@ Release Notes .. toctree:: :maxdepth: 1 + releases/1.0.0 releases/0.7.0 releases/0.6.0 releases/0.5.1 diff --git a/docs/releases/1.0.0.rst b/docs/releases/1.0.0.rst new file mode 100644 index 0000000..27b3ab8 --- /dev/null +++ b/docs/releases/1.0.0.rst @@ -0,0 +1,47 @@ +.. _v1.0.0: + +neurotic 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 `__) diff --git a/setup.py b/setup.py index cd17d7c..8ca0bda 100644 --- a/setup.py +++ b/setup.py @@ -10,10 +10,10 @@ # Change version number here, not in neurotic/version.py, which is generated # by this script. Try to follow recommended versioning guidelines at semver.org. -MAJOR = 0 # increment for backwards-incompatible changes -MINOR = 8 # increment for backwards-compatible feature additions +MAJOR = 1 # increment for backwards-incompatible changes +MINOR = 0 # increment for backwards-compatible feature additions MICRO = 0 # increment for backwards-compatible bug fixes -IS_RELEASED = False # determines whether version will be marked as development +IS_RELEASED = True # determines whether version will be marked as development VERSION = f'{MAJOR}.{MINOR}.{MICRO}' # Try to fetch the git revision number from the .git directory if it exists, @@ -111,7 +111,7 @@ 'Bug tracker': 'https://github.com/jpgill86/neurotic/issues', }, classifiers = [ - 'Development Status :: 4 - Beta', + 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Science/Research', 'License :: OSI Approved :: MIT License', 'Operating System :: OS Independent',