diff --git a/README.rst b/README.rst index e9f0442d..de10a74e 100644 --- a/README.rst +++ b/README.rst @@ -28,11 +28,6 @@ FOOOF - fitting oscillations & one over f FOOOF is a fast, efficient, and physiologically-informed tool to parameterize neural power spectra. -Note: FOOOF is currently on a pre-release. Please check the install instructions for -updating to the pre-release version, and check the -`changelog `_ -for how to get started with the new version. - Overview -------- @@ -94,19 +89,9 @@ We recommend using the `Anaconda `_ dist Installation ------------ -**Pre-Release Version** - -To install the current pre-release version, use pip: - -.. code-block:: shell - - $ pip install fooof --pre - -If you already have a version of FOOOF installed, you will need to remove it first: - -.. code-block:: shell +The current major release of FOOOF is the 1.X.X series, which is a breaking change from the prior 0.X.X series. - $ pip uninstall fooof +Check the `changelog `_ for notes on updating to the new version. **Stable Version** diff --git a/doc/changelog.rst b/doc/changelog.rst index 0fcc4424..2e189aac 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -1,14 +1,13 @@ Code Changelog ============== -This page contains the changelog and updating instructions for the current pre-release -version of FOOOF 1.0.0rcX. +This page contains the changelog for the FOOOF codebase and any notes on updating between versions. -Changelogs for prior released versions of FOOOF are available at the -`release page `_. +This page primarly notes changes for major version updates. For notes on the specific updates +for minor releases, see the `release page `_. -1.0.0 (Pre-Release) -------------------- +1.0.0 +----- Warning: the 1.X.X release series is an API breaking release from the from 0.X.X series. @@ -85,3 +84,11 @@ The 1.X.X series comes with a greatly updated documentation site, in which as we updating the tutorials and existing documentation, there are a large number of extra examples, and a new 'motivations' section, exploring why 'parameterizing neural power spectra' is a useful idea & method. + +0.1.X +----- + +The 0.1.X series of releases for FOOOF was the initial release series of FOOOF, with the original naming scheme. This series is now deprecated. + +These releases can still be accessed, and are described, on the +`release page `_ diff --git a/doc/img/FOOOFGroup_report.png b/doc/img/FOOOFGroup_report.png index 12563cbc..54276e94 100644 Binary files a/doc/img/FOOOFGroup_report.png and b/doc/img/FOOOFGroup_report.png differ diff --git a/doc/img/spectrum.png b/doc/img/spectrum.png index aed2d6cf..08ece62f 100644 Binary files a/doc/img/spectrum.png and b/doc/img/spectrum.png differ diff --git a/fooof/version.py b/fooof/version.py index 2a048dfe..75977e6f 100644 --- a/fooof/version.py +++ b/fooof/version.py @@ -1 +1 @@ -__version__ = '1.0.0rc4' \ No newline at end of file +__version__ = '1.0.0' \ No newline at end of file diff --git a/motivations/README.txt b/motivations/README.txt index 297ed777..90ae0899 100644 --- a/motivations/README.txt +++ b/motivations/README.txt @@ -3,9 +3,9 @@ Motivations =========== -This section explores conceptual and methodological ideas that motivate the need for parameterizing neural power spectra. +This section explores conceptual and methodological ideas that motivate parameterizing neural power spectra. -Using code examples, this section is organized into sections covering: +Using code examples, topics are organized into: - conceptual points about approaches for analyzing neural data and related topics in digital signal processing - methodological points investigating if and how current approaches may conflate different aspects of the data diff --git a/setup.cfg b/setup.cfg index 224a7795..5aef279b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,2 +1,2 @@ [metadata] -description-file = README.md \ No newline at end of file +description-file = README.rst diff --git a/setup.py b/setup.py index 60cb9459..ad426c90 100644 --- a/setup.py +++ b/setup.py @@ -22,15 +22,15 @@ 1) an aperiodic component, reflecting 1/f like characteristics, modeled with an exponential fit, with 2) band-limited peaks, reflecting putative oscillations, and modeled as Gaussians -The FOOOF codebase includes: +The module includes: - Code for applying models to parameterize neural power spectra - Plotting functions for visualizing power spectra, model fits, and model parameters -- Analysis functions for examing model components and parameters +- Analysis functions for examining model components and parameters - Utilities for Input/Output management, data management and analysis reports - Simulation code for simulating power spectra for methods testing -More details on FOOOF tool and codebase are available on the documentation site +More details are available on the documentation site. Documentation: https://fooof-tools.github.io/ @@ -41,7 +41,7 @@ A full description of the method and approach is available in this paper. -Direct Paper Link: https://www.biorxiv.org/content/early/2018/04/11/299859 +Direct Paper Link: https://www.biorxiv.org/content/10.1101/299859v1 """ setup(