Skip to content

Commit

Permalink
REL: v0.13 (#1156)
Browse files Browse the repository at this point in the history
* REL: v0.13

* remove typo [skip ci]

* whatsnew: remove notable changes, mark date for upcoming change
  • Loading branch information
sappelhoff authored Aug 21, 2023
1 parent 7ba64ac commit a2dff29
Show file tree
Hide file tree
Showing 8 changed files with 39 additions and 39 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/unit_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,11 @@ jobs:
run: |
python -m pip install .[full]
python -c 'import mne_bids; print(mne_bids.__version__)'
python -c 'import pybv; print(pybv.__version__)'
python -c 'import nibabel; print(nibabel.__version__)'
python -c 'import pybv; print(pybv.__version__)'
python -c 'import pymatreader; print(pymatreader.__version__)'
python -c 'import matplotlib; print(matplotlib.__version__)'
python -c 'import pandas; print(pandas.__version__)'
python -c 'import pymatreader; print(pymatreader.__version__)'
python -c 'import EDFlib; print("EDFlib has no .__version__")'
test:
Expand Down Expand Up @@ -171,13 +171,13 @@ jobs:
- name: Install MNE (stable)
if: "matrix.mne-version == 'mne-stable'"
run: |
git clone --single-branch --branch maint/1.4 https://github.com/mne-tools/mne-python.git
git clone --single-branch --branch maint/1.5 https://github.com/mne-tools/mne-python.git
python -m pip install -e ./mne-python
- name: Install MNE (previous stable)
if: "matrix.mne-version == 'mne-prev-stable'"
run: |
git clone --single-branch --branch maint/1.3 https://github.com/mne-tools/mne-python.git
git clone --single-branch --branch maint/1.4 https://github.com/mne-tools/mne-python.git
python -m pip install -e ./mne-python
- name: Install MNE (main)
Expand Down
11 changes: 8 additions & 3 deletions doc/_static/versions.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
[
{
"name": "0.13 (devel)",
"name": "0.14 (devel)",
"version": "dev",
"url": "https://mne.tools/mne-bids/dev/"
},
{
"name": "0.12 (stable)",
"name": "0.13 (stable)",
"version": "dev",
"url": "https://mne.tools/mne-bids/v0.13/"
},
{
"name": "0.12",
"version": "stable",
"url": "https://mne.tools/mne-bids/stable/"
"url": "https://mne.tools/mne-bids/v0.12/"
},
{
"name": "0.11",
Expand Down
23 changes: 12 additions & 11 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Dependencies

Required:

* ``mne`` (>=1.3)
* ``mne`` (>=1.4)
* ``numpy`` (>=1.20.2)
* ``scipy`` (>=1.6.3)

Expand All @@ -25,9 +25,11 @@ Optional:
* ``pandas`` (>=1.2.4, for generating event statistics)
* ``EDFlib-Python`` (>=1.0.6, for writing EDF data)

We recommend the `Anaconda <https://www.anaconda.com/download/>`_ Python distribution.
We recommend installing ``mne-bids`` into an isolated Python environment,
for example created via ``conda``
(may be obtained through `miniconda <https://docs.conda.io/en/latest/miniconda.html>`_).
We require that you **use Python 3.8 or higher**.
You may choose to install ``mne-bids``
You may choose to install ``mne-bids`` into your isolated Python environment
`via pip <#installation-via-pip>`_ or
`via conda <#installation-via-conda>`_.

Expand All @@ -42,10 +44,10 @@ simply run:
pip install --upgrade mne-bids[full]
This ``pip`` command will also work if you want to upgrade if a newer version
of ``mne-bids`` is available.
of MNE-BIDS is available.

If you don't require advanced features like interactive visual data inspection,
you may also install a basic version of ``mne-bids`` via
you may also install a basic version of MNE-BIDS via

.. code-block:: bash
Expand All @@ -55,7 +57,7 @@ If you want to install a snapshot of the current development version, run:

.. code-block:: bash
pip install --upgrade https://api.github.com/repos/mne-tools/mne-bids/zipball/main
pip install --upgrade git+https://github.com/mne-tools/mne-bids
To check if everything worked fine, the following command should
print a version number and not give any error messages:
Expand All @@ -68,14 +70,13 @@ MNE-BIDS works best with the latest stable release of MNE-Python (the ``mne`` pa
To ensure MNE-Python is up-to-date, follow the
`MNE-Python installation instructions <https://mne.tools/stable/install/#>`_.


Installation via conda
----------------------

If you have followed the
`MNE-Python installation instructions <https://mne.tools/stable/install/#>`_,
all that's left to do is to install ``mne-bids`` without its dependencies, as
they've already been installed during the MNE-Python installation process.
all that's left to do is to install MNE-BIDS without its dependencies,
as they've already been installed during the MNE-Python installation process.

Activate the correct ``conda`` environment and install ``mne-bids``:

Expand All @@ -84,7 +85,7 @@ Activate the correct ``conda`` environment and install ``mne-bids``:
conda activate mne
conda install --channel conda-forge --no-deps mne-bids
This approach ensures that the installation of ``mne-bids`` doesn't alter any
This approach ensures that the installation of MNE-BIDS doesn't alter any
other packages in your existing ``conda`` environment.

Alternatively, you may wish to take advantage of the fact that the
Expand All @@ -97,7 +98,7 @@ dependencies) will provide you with a working copy of of both ``mne`` and
conda create --name mne --channel conda-forge mne-bids
After activating the environment, you should be ready to use ``mne-bids``:
After activating the environment, you should be ready to use MNE-BIDS:

.. code-block:: bash
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ pillow
pandas
mne-nirs
seaborn
openneuro-py
20 changes: 7 additions & 13 deletions doc/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,26 @@ What's new?

.. _changes_0_13:

Version 0.13 (unreleased)
Version 0.13 (2023-08-xx)
-------------------------

...

📝 Notable changes
~~~~~~~~~~~~~~~~~~

- ...

👩🏽‍💻 Authors
~~~~~~~~~~~~~~~

The following authors contributed for the first time. Thank you so much! 🤩

* `Laetitia Fesselier`_
* `Jonathan Vanhoecke`_
* `Ford McDonald`_
* `Jonathan Vanhoecke`_
* `Laetitia Fesselier`_
* `Pierre Guetschel`_

The following authors had contributed before. Thank you for sticking around! 🤘

* `Richard Höchenberger`_
* `Adam Li`_
* `Alexandre Gramfort`_
* `Eric Larson`_
* `Richard Höchenberger`_
* `Stefan Appelhoff`_
* `Adam Li`_

Detailed list of changes
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -55,7 +49,7 @@ Detailed list of changes
🛠 Requirements
^^^^^^^^^^^^^^^

- MNE-BIDS now requires MNE-Python 1.3 or newer.
- MNE-BIDS now requires MNE-Python 1.4 or newer.

🪲 Bug fixes
^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion mne_bids/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""MNE software for easily interacting with BIDS compatible datasets."""

__version__ = "0.13.dev0"
__version__ = "0.13"
from mne_bids import commands
from mne_bids.report import make_report
from mne_bids.path import (
Expand Down
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ project_urls =
[options]
python_requires = ~= 3.8
install_requires =
mne >= 1.3
mne >= 1.4
numpy >= 1.20.2
scipy >= 1.6.3
packages = find:
Expand All @@ -44,10 +44,10 @@ include_package_data = True
full =
nibabel >= 3.2.1
pybv >= 0.7.5
pymatreader >= 0.0.30
matplotlib >= 3.4.0
pandas >= 1.2.4
EDFlib-Python >= 1.0.6
pymatreader >= 0.0.30

[options.entry_points]
console_scripts =
Expand Down
9 changes: 4 additions & 5 deletions test_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
mne>=1.4
numpy>=1.20.2
scipy>=1.6.3
mne>=1.3
matplotlib>=3.4.0
pandas>=1.2.4
nibabel>=3.2.1
pybv>=0.7.5
openneuro-py>=2022.2
EDFlib-Python>=1.0.6
pymatreader>=0.0.30
matplotlib>=3.4.0
pandas>=1.2.4
EDFlib-Python>=1.0.6
pytest
pytest-cov
pytest-sugar
Expand Down

0 comments on commit a2dff29

Please sign in to comment.