Skip to content

Commit

Permalink
Add requirements.txt.
Browse files Browse the repository at this point in the history
This commit fixes Issue #8

We add numpy==1.15 to conform with module `pacpy`.

We also add install instructions to README.
  • Loading branch information
jusjusjus committed Jan 29, 2019
1 parent 9fff187 commit bd0ff92
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ The main entry point into the library is class `Reader` that accesses a
selection of functions in the .mff directory to return signal data and its meta
information.

## Installation

```bash
$ conda create -n mffpy python=3.6 pip
$ conda activate mffpy
$ pip install -r requirements.txt
$ # and to run the test
$ pytest
```

## View the Docs

All documentation and API guidance are generated from the python doc-strings
Expand Down
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
pytest==4.1.1
numpy==1.15

0 comments on commit bd0ff92

Please sign in to comment.