Python 3.10 is tested for support by spaghetti. Please make sure that you are operating in a Python >= 3.10 environment.

# Installation

## Installing with `conda` via spaghetti-feedstock (highly recommended)

To install spaghetti and all its dependencies, we recommend using the conda manager, specifically with the conda-forge channel. This can be obtained by installing the Anaconda Distribution (a free Python distribution for data science), or through miniconda (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

Also, `geopandas` provides a nice example to create a fresh environment for working with spatial data.

## Installing with Python Package Index

    $ 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 here. Using `conda` (above) avoids having to install the dependencies separately.

## Development Version

Install the most current development version of spaghetti by running:

    $ pip install git+https://github.com/pysal/spaghetti

You can also fork the pysal/spaghetti repo and create a local clone of your fork. By making changes to your local clone and submitting a pull request to pysal/spaghetti, you can contribute to the spaghetti development.