Skip to content

Commit

Permalink
Merge pull request #295 from pysal/jGaboardi-patch-2
Browse files Browse the repository at this point in the history
update of install instructions in README.md
  • Loading branch information
jGaboardi committed Jul 29, 2019
2 parents a626ae4 + 52c8d94 commit dc7ff4c
Showing 1 changed file with 26 additions and 14 deletions.
40 changes: 26 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,18 +68,32 @@ Examples
Installation
------------

Install the latest stable of `spaghetti` via [PyPI](https://pypi.org/project/spaghetti/) by running:
As of version 1.3, `spaghetti` officially supports Python [`3.6`](https://docs.python.org/3.6/) and [`3.7`](https://docs.python.org/3.7/) only. Please make sure that you are operating in a Python 3 environment.

```
$ pip install spaghetti
```
**Installing with `conda` via [conda-forge](https://github.com/conda-forge/spaghetti-feedstock) (highly recommended)**

Install the latest stable of `spaghetti` via [conda-forge](https://github.com/conda-forge/spaghetti-feedstock) by running:
To install `spaghetti` and all its dependencies, we recommend using the [`conda`](https://docs.conda.io/en/latest/)
manager, specifically with the [`conda-forge`](https://conda-forge.org) channel. This can be obtained by installing the [`Anaconda Distribution`](https://docs.continuum.io/anaconda/) (a free Python distribution for data science), or through [`miniconda`](https://docs.conda.io/en/latest/miniconda.html) (minimal distribution only containing Python and the conda package manager).

Using `conda`, `spaghetti` can be installed as follows:
```
$ conda config --set channel_priority strict
$ conda install --channel conda-forge spaghetti
```

**Installing with [`PyPI`](https://pypi.org/project/spaghetti/)**
```
$ pip install spaghetti
```
*or* download the source distribution (`.tar.gz`) and decompress it to your selected destination. Open a command shell and navigate to the decompressed folder.
```
$ pip install .
```

**Warning**

When installing via `pip`, you have to ensure that the required dependencies for `spaghetti` are installed on your operating system. Details on how to install these packages are linked below. Using `conda` (above) avoids having to install the dependencies separately.

Install the most current development version of `spaghetti` by running:

```
Expand All @@ -89,18 +103,16 @@ $ pip install git+https://github.com/pysal/spaghetti

Requirements
------------

- `scipy`
- `numpy`
- `esda`
- `rtree`

- [`esda`](https://esda.readthedocs.io/en/latest/)
- [`libspatialindex`](https://libspatialindex.org/index.html)
- [`numpy`](https://numpy.org/devdocs/)
- [`rtree`](http://toblerity.org/rtree/install.html)
- [`scipy`](http://scipy.github.io/devdocs/)

Soft Dependencies
-----------------
- `shapely`
- `geopandas`

- [`geopandas`](http://geopandas.org/install.html)
- [`shapely`](https://shapely.readthedocs.io/en/latest/)

Contribute
----------
Expand Down

0 comments on commit dc7ff4c

Please sign in to comment.