Skip to content

Commit af3f09c

Browse files
committed
add version check to ref page
1 parent 172101a commit af3f09c

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

doc/reference.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ In addition, we recommend that reports should include information on:
5454
Reporting Template & Example
5555
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5656

57-
To assist in reporting on using FOOOF, we have created some templates for reporting on spectral parameterization methods. There are also some utilities included in the code to collected the required information.
57+
To assist in reporting on using FOOOF, we have created some templates for reporting on spectral parameterization methods. There are also some utilities included in the code to collected the required information.
5858

5959
The following box is an example of what a methods report might look like (where all of the *X*'s should be filled in with the relevant information).
6060

@@ -65,6 +65,18 @@ The following box is an example of what a methods report might look like (where
6565
peak threshold : *XX*; and aperiodic mode : *XX*. Power spectra were parameterized across
6666
the frequency range *XX* to *XX* Hz.
6767

68+
Checking module version
69+
~~~~~~~~~~~~~~~~~~~~~~~
70+
71+
If you are not sure which version of the module you have installed, you can
72+
check the `__version__` from Python, using the following code:
73+
74+
.. code-block:: python
75+
76+
# Check the version of the tool
77+
from fooof import __version__ as fooof_version
78+
print('Current fooof version:', fooof_version)
79+
6880
Generating Methods Reports
6981
~~~~~~~~~~~~~~~~~~~~~~~~~~
7082

0 commit comments

Comments
 (0)