Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
richardkoehler committed Feb 3, 2022
2 parents 74a2ea9 + 45110df commit 3522be9
Showing 1 changed file with 32 additions and 23 deletions.
55 changes: 32 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
[![Homepage][homepage-shield]][homepage-url]
[![Python Versions][python-shield]][python-url]
[![PyPi][pypi-shield]][pypi-url]
[![Tests][tests-shield]][tests-url]
[![License][license-shield]][license-url]
[![Contributors][contributors-shield]][contributors-url]
[![Code Style][codestyle-shield]][codestyle-url]
[![Homepage][homepage-shield]][homepage-url]


# PTE Stats - Python tools for electrophysiology
Expand All @@ -13,66 +16,72 @@ PTE Stats is particularly useful with intracranial EEG (iEEG) data such as local

## Installing pte-stats

First, get the current development version of pte-stats using [git](https://git-scm.com/). Type the following command into a terminal:

```bash
git clone https://github.com/richardkoehler/pte-stats
```
### Stable release

Use the package manager [conda](https://docs.conda.io/projects/conda/en/latest/index.html) to set up a new working environment. To do so navigate to the pte-stats root directory in your terminal and type:
To install the latest stable release, simply type:

```bash
conda env create -f env.yml
$ pip install pte-stats
```

This will set up a new conda environment called ``pte-stats``.
### Development version

To activate the environment then type:
To install the latest delevopment version, first clone this repository:

```bash
conda activate pte-stats
$ git clone https://github.com/richardkoehler/pte-stats
```

Finally, to install pte-stats in an editable development version inside your conda enviroment type the following inside the pte-stats root directory:
Then install with the command:

```bash
conda develop .
$ pip install .
```


## Usage

```python
import pte_stats

# Examples
# Examples coming soon
```

## Contributing
Please feel free to contribute yourselves or to open an **issue** when you encounter a bug or would like to add a new feature.

Please feel free to contribute yourselves or to open an **issue** when you encounter a bug or to request a new feature.

For any minor additions or bugfixes, you may simply create a **pull request**.

For any major changes, make sure to open an **issue** first. When you then create a pull request, be sure to **link the pull request** to the open issue in order to close the issue automatically after merging.

To contribute yourselves, consider installing the full conda development environment to include such tools as black, pylint and isort:
### How to contribute
To contribute yourselves, you should fork this repository, and create your a development branch from your fork.

Then, inside your development branch run the command:

```bash
conda env create -f env_dev.yml
conda activate pte-stats-dev
$ pip install -e .[dev]
```

Continuous Integration (CI) including automated testing are set up.
This will additionally install packages for development, such as black, pylint, mypy and isort.

## License
PTE Stats is licensed under the [MIT license](license-url).

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[homepage-shield]: https://img.shields.io/static/v1?label=Homepage&message=ICN&logoColor=black&labelColor=grey&logoWidth=20&color=9cf&style=for-the-badge
[python-shield]: https://img.shields.io/static/v1?label=Python&message=3.9|3.10&logoColor=black&labelColor=grey&color=blue
[python-url]: https://pypi.org/project/pte-stats/
[pypi-shield]: https://img.shields.io/static/v1?label=PyPi&message=v0.1.0&logoColor=black&labelColor=grey&color=blue
[pypi-url]: https://pypi.org/project/pte-stats/
[tests-shield]: https://github.com/richardkoehler/pte-stats/actions/workflows/tests.yml/badge.svg
[tests-url]: https://github.com/richardkoehler/pte-stats/actions/workflows/tests.yml
[homepage-shield]: https://img.shields.io/static/v1?label=Homepage&message=ICN&logoColor=black&labelColor=grey&logoWidth=20&color=9cf
[homepage-url]: https://www.icneuromodulation.org/
[contributors-shield]: https://img.shields.io/github/contributors/richardkoehler/pte-stats.svg?style=for-the-badge
[contributors-shield]: https://img.shields.io/github/contributors/richardkoehler/pte-stats.svg
[contributors-url]: https://github.com/richardkoehler/pte-stats/graphs/contributors
[license-shield]: https://img.shields.io/static/v1?label=License&message=MIT&logoColor=black&labelColor=grey&logoWidth=20&color=yellow&style=for-the-badge
[license-shield]: https://img.shields.io/static/v1?label=License&message=MIT&logoColor=black&labelColor=grey&logoWidth=20&color=yellow
[license-url]: https://github.com/richardkoehler/pte-stats/blob/main/LICENSE/
[codestyle-shield]: https://img.shields.io/static/v1?label=CodeStyle&message=black&logoColor=black&labelColor=grey&logoWidth=20&color=black&style=for-the-badge
[codestyle-shield]: https://img.shields.io/static/v1?label=CodeStyle&message=black&logoColor=black&labelColor=grey&logoWidth=20&color=black
[codestyle-url]: https://github.com/psf/black

0 comments on commit 3522be9

Please sign in to comment.