Skip to content

Commit

Permalink
add conda badge
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Dec 9, 2024
1 parent a0d4d7b commit 33f9c85
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Test coverage](https://codecov.io/gh/sappelhoff/eeg_positions/branch/main/graph/badge.svg)](https://codecov.io/gh/sappelhoff/eeg_positions)
[![Documentation status](https://readthedocs.org/projects/eeg-positions/badge/?version=latest)](https://eeg-positions.readthedocs.io/en/latest/?badge=latest)
[![PyPi version](https://img.shields.io/pypi/v/eeg_positions.svg)](https://pypi.org/project/eeg_positions/)
[![Conda version](https://img.shields.io/conda/vn/conda-forge/eeg_positions.svg)](https://anaconda.org/conda-forge/eeg_positions)
[![Zenodo archive](https://zenodo.org/badge/136149692.svg)](https://zenodo.org/badge/latestdoi/136149692)

# eeg_positions
Expand All @@ -18,11 +19,25 @@ There are two common ways to make use of this repository:
1. Go to the `data/` directory and download the EEG electrode position files you need
(see the [README](https://github.com/sappelhoff/eeg_positions/tree/main/data) there).

1. Use `eeg_positions` as a Python package (install through `pip install eeg_positions`),
1. Use `eeg_positions` as a Python package (install instructions below),
and then obtain the EEG electrode positions through the `get_elec_coords` function.
See the [Examples](https://eeg-positions.readthedocs.io/en/latest/auto_examples/index.html)
and [API documentation](https://eeg-positions.readthedocs.io/en/latest/api.html).

## Installation

For installing the **stable** version of `eeg_positions`, call:

`python -m pip install --upgrade eeg_positions`

Or if you use [conda](https://docs.conda.io/en/latest/miniconda.html):

`conda install --channel conda-forge eeg_positions`

For installing the **latest (development)** version of `eeg_positions`, call:

`python -m pip install --upgrade https://github.com/sappelhoff/eeg_positions/archive/refs/heads/main.zip`

## Contributing

The development of `eeg_positions` is taking place on
Expand Down

0 comments on commit 33f9c85

Please sign in to comment.