search

fooof-tools / fooof

Parameterizing neural power spectra into periodic & aperiodic components.
https://fooof-tools.github.io/
Apache License 2.0
363 stars 98 forks source link

specparam - FOOOF confusion #318

Closed chapochn closed 7 months ago

chapochn commented 8 months ago

Hello,

in the quickstart example it's written:

from specparam import SpectralModel

But I don't see the option to download specparam2.0 anywhere. Am I missing something?

Also running FOOOF I am getting:

The `fooof` package is being deprecated and replaced by the `specparam` (spectral parameterization) package.
This version of `fooof` (1.1) is fully functional, but will not be further updated.
New projects are recommended to update to using `specparam` (see Changelog for details)

I am not seeing how to start using specparam. Could you please advise? Thank you!

TomDonoghue commented 8 months ago

Sorry for the confusion - specparam hasn't been properly released yet, so fooof 1.1 is the most recent fully available version. We added the note about updating because soon there will be a new release that effectively deprecates the fooof package, but there's still a bit more work to do before everything officially switches, so until then the Github is basically ahead of what's released, and the warning on 1.1 is a bit premature.

I'll look into tweaking the docs and/or warning to be clearer on this.

chapochn commented 8 months ago

ok, gotcha, thanks for clarifying!

TomDonoghue commented 7 months ago

I've added some notes to the documentation to more explicitly describe what's going on between the fooof / specparam versions! I'll keep updating these as we make further candidate releases, and ultimately switch fully to the new version.

Since that hopefully addresses the topic of this issue, I'm going to close this now - but do feel free to follow up with any further questions, etc!