Skip to content

Commit e27e142

Browse files
committed
Tweaks for release
1 parent 0d5b513 commit e27e142

File tree

8 files changed

+23
-31
lines changed

8 files changed

+23
-31
lines changed

README.rst

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,6 @@ FOOOF - fitting oscillations & one over f
2828

2929
FOOOF is a fast, efficient, and physiologically-informed tool to parameterize neural power spectra.
3030

31-
Note: FOOOF is currently on a pre-release. Please check the install instructions for
32-
updating to the pre-release version, and check the
33-
`changelog <https://fooof-tools.github.io/fooof/changelog.html>`_
34-
for how to get started with the new version.
35-
3631
Overview
3732
--------
3833

@@ -94,19 +89,9 @@ We recommend using the `Anaconda <https://www.anaconda.com/distribution/>`_ dist
9489
Installation
9590
------------
9691

97-
**Pre-Release Version**
98-
99-
To install the current pre-release version, use pip:
100-
101-
.. code-block:: shell
102-
103-
$ pip install fooof --pre
104-
105-
If you already have a version of FOOOF installed, you will need to remove it first:
106-
107-
.. code-block:: shell
92+
The current major release of FOOOF is the 1.X.X series, which is a breaking change from the prior 0.X.X series.
10893

109-
$ pip uninstall fooof
94+
Check the `changelog <https://fooof-tools.github.io/fooof/changelog.html>`_ for notes on updating to the new version.
11095

11196
**Stable Version**
11297

doc/changelog.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
Code Changelog
22
==============
33

4-
This page contains the changelog and updating instructions for the current pre-release
5-
version of FOOOF 1.0.0rcX.
4+
This page contains the changelog for the FOOOF codebase and any notes on updating between versions.
65

7-
Changelogs for prior released versions of FOOOF are available at the
8-
`release page <https://github.com/fooof-tools/fooof/releases>`_.
6+
This page primarly notes changes for major version updates. For notes on the specific updates
7+
for minor releases, see the `release page <https://github.com/fooof-tools/fooof/releases>`_.
98

10-
1.0.0 (Pre-Release)
11-
-------------------
9+
1.0.0
10+
-----
1211

1312
Warning: the 1.X.X release series is an API breaking release from the from 0.X.X series.
1413

@@ -85,3 +84,11 @@ The 1.X.X series comes with a greatly updated documentation site, in which as we
8584
updating the tutorials and existing documentation, there are a large number of extra
8685
examples, and a new 'motivations' section, exploring why 'parameterizing neural power spectra'
8786
is a useful idea & method.
87+
88+
0.1.X
89+
-----
90+
91+
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.
92+
93+
These releases can still be accessed, and are described, on the
94+
`release page <https://github.com/fooof-tools/fooof/releases>`_

doc/img/FOOOFGroup_report.png

-99 Bytes
Loading

doc/img/spectrum.png

-383 Bytes
Loading

fooof/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '1.0.0rc4'
1+
__version__ = '1.0.0'

motivations/README.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
Motivations
44
===========
55

6-
This section explores conceptual and methodological ideas that motivate the need for parameterizing neural power spectra.
6+
This section explores conceptual and methodological ideas that motivate parameterizing neural power spectra.
77

8-
Using code examples, this section is organized into sections covering:
8+
Using code examples, topics are organized into:
99

1010
- conceptual points about approaches for analyzing neural data and related topics in digital signal processing
1111
- methodological points investigating if and how current approaches may conflate different aspects of the data

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
[metadata]
2-
description-file = README.md
2+
description-file = README.rst

setup.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222
1) an aperiodic component, reflecting 1/f like characteristics, modeled with an exponential fit, with
2323
2) band-limited peaks, reflecting putative oscillations, and modeled as Gaussians
2424
25-
The FOOOF codebase includes:
25+
The module includes:
2626
2727
- Code for applying models to parameterize neural power spectra
2828
- Plotting functions for visualizing power spectra, model fits, and model parameters
29-
- Analysis functions for examing model components and parameters
29+
- Analysis functions for examining model components and parameters
3030
- Utilities for Input/Output management, data management and analysis reports
3131
- Simulation code for simulating power spectra for methods testing
3232
33-
More details on FOOOF tool and codebase are available on the documentation site
33+
More details are available on the documentation site.
3434
3535
Documentation: https://fooof-tools.github.io/
3636
@@ -41,7 +41,7 @@
4141
4242
A full description of the method and approach is available in this paper.
4343
44-
Direct Paper Link: https://www.biorxiv.org/content/early/2018/04/11/299859
44+
Direct Paper Link: https://www.biorxiv.org/content/10.1101/299859v1
4545
"""
4646

4747
setup(

0 commit comments

Comments
 (0)