Skip to content

Commit

Permalink
Updated install instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiodsf committed Sep 15, 2021
1 parent 904349e commit aec3941
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 6 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,29 @@ Based on original code from [NIMH MEG Core Facility].

## Installation

### C compiler
### Using pip and PyPI (preferred method)

Part of this Python package is written in C, so you will need a C compiler.
The latest release of Stockwell is available on the
[Python Package Index](https://pypi.org/project/stockwell/).

You can install it easily through `pip`:

pip install stockwell


### Installation from source

If no precompiled package is available for you architecture on PyPI, or if you
want to work on the source code, you will need to compile this package from
source.

To obtain the source code, download the latest release from the [releases
page](https://github.com/claudiodsf/stockwell/releases), or clone the GitHub
project.

#### C compiler

Part of Stockwell is written in C, so you will need a C compiler.

On Linux (Debian or Ubuntu), install the `build-essential` package:

Expand All @@ -26,9 +46,10 @@ On Windows, install the [Microsoft C++ Build Tools].
[Microsoft C++ Build Tools]:
https://visualstudio.microsoft.com/visual-cpp-build-tools

### FFTW
#### FFTW

Make sure that you have [FFTW](http://www.fftw.org) installed.
To compile Stockwell, you will need to have [FFTW](http://www.fftw.org)
installed.

If you use Anaconda (Linux, macOS, Windows):

Expand All @@ -42,7 +63,7 @@ If you use `apt` (Debian or Ubuntu)

sudo apt install libfftw3-dev

### Install the Python package
#### Install the Python package from source

Finally, install this Python package using pip:

Expand Down
8 changes: 7 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,13 @@
from version import __version__

with open('README.md', 'rb') as f:
long_descr = f.read().decode('utf-8')
long_descr = f.read().decode('utf-8').replace(
'(stockwell.png)',
'(https://cdn.jsdelivr.net/gh/claudiodsf/stockwell/stockwell.png)'
).replace(
'(inv_stockwell.png)',
'(https://cdn.jsdelivr.net/gh/claudiodsf/stockwell/inv_stockwell.png)'
)

include_dirs_st = [numpy.get_include()]
library_dirs_st = []
Expand Down

0 comments on commit aec3941

Please sign in to comment.