Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update dependencies #921

Merged
merged 1 commit into from
Nov 24, 2021
Merged

doc: update dependencies #921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/unit_tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ jobs:
python -c 'import nibabel; print(nibabel.__version__)'
python -c 'import matplotlib; print(matplotlib.__version__)'
python -c 'import pandas; print(pandas.__version__)'
python -c 'import openneuro; print(openneuro.__version__)'

test:
timeout-minutes: 60
Expand Down
19 changes: 13 additions & 6 deletions doc/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,23 @@ Installation
Dependencies
------------

* ``mne`` (>=0.21.2)
Required:

* ``mne`` (>=0.24)
* ``numpy`` (>=1.16.0)
* ``scipy`` (>=1.2.0, or >=1.5.0 for certain operations with EEGLAB data)
* ``nibabel`` (>=2.2, optional, for processing MRI data)
* ``pybv`` (>=0.6, optional, for writing BrainVision data)
* ``pandas`` (>=0.24.0, optional, for generating event statistics)
* ``matplotlib`` (>=3.1.0, optional, for using the interactive data inspector)
* ``setuptools`` (>=46.4.0)

Optional:

* ``nibabel`` (>=2.5, for processing MRI data)
* ``pybv`` (>=0.6, for writing BrainVision data)
* ``matplotlib`` (>=3.1.0, for using the interactive data inspector)
* ``pandas`` (>=0.24.0, for generating event statistics)
* ``EDFlib-Python`` (>=1.0.2, for writing EDF data)

We recommend the `Anaconda <https://www.anaconda.com/download/>`_ Python distribution.
We require that you use Python 3.7 or higher.
We require that you **use Python 3.7 or higher**.
You may choose to install ``mne-bids``
`via pip <#Installation via pip>`_ or
`via conda <#Installation via conda>`_.
Expand Down
3 changes: 1 addition & 2 deletions setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,10 @@ include_package_data = True

[options.extras_require]
full =
nibabel >= 2.2
nibabel >= 2.5
pybv >= 0.6
matplotlib >= 3.1.0
pandas >= 0.24.0
openneuro-py >= 2021.8
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remove openneuro-py here because we only need it for the documentation (like nilearn, etc.) ... so it's good enough for it to live in docs/requirements.txt

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well full means also doc to me. It's also pure Python package. Otherwise we can do a [doc] install target

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, but then we'd need a couple of more packages there as well right? sphinx, nilearn, sphinx-copybutton, ...

mne-bids/doc/requirements.txt

Lines 1 to 10 in ff5cded

nilearn
sphinx <4.3
sphinx_gallery
sphinx-copybutton
pydata-sphinx-theme
numpydoc
matplotlib
pillow
pandas
setuptools

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, full means full functionality for a user, but no dev deps. Building docs is a dev operation. I don't think full needs to support this

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rather agree with @hoechenberger here - but Richard: why would you then include openneuro-py in "full"?

EDIT: just saw that you approved, so you are probably fine with this.

EDFlib-Python >= 1.0.2

[options.entry_points]
Expand Down