Skip to content

Commit

Permalink
docs(readme): add installation instructions (#33)
Browse files Browse the repository at this point in the history
* docs(readme): add installation instructions

* Update README.md
  • Loading branch information
wilhelmagren authored Sep 24, 2023
1 parent f30cfeb commit 22b66b7
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
[![PyPi version](https://img.shields.io/pypi/v/neurocode.svg)](https://pypi.org/project/neurocode/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![codecov](https://codecov.io/gh/neurocode-ai/neurocode/graph/badge.svg?token=IQD60CY83U)](https://codecov.io/gh/neurocode-ai/neurocode)
[![Lines of code](https://img.shields.io/tokei/lines/github/neurocode-ai/neurocode)](https://github.com/neurocode-ai/neurocode)
[![Unit Tests](https://github.com/neurocode-ai/neurocode/actions/workflows/unittests.yml/badge.svg)](https://github.com/neurocode-ai/neurocode/actions/workflows/unittests.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Expand All @@ -21,6 +20,18 @@
## πŸ”Ž Overview
A minimalistic Python library for EEG/MEG deep learning research, primarely focused on self-supervised learning.

## πŸ“¦ Installation
Either clone this repository and perform a local install accordingly
```
git clone https://github.com/neurocode-ai/neurocode.git
cd neurocode
pip install -e .
```
or install the most recent release from the Python Package Index (PyPI).
```
pip install neurocode
```

## πŸš€ Example usage
Below you can see an example adapted for a SSL training workflow using the SimCLR framework.

Expand Down

0 comments on commit 22b66b7

Please sign in to comment.