Skip to content

Latest commit

 

History

History
118 lines (76 loc) · 3.72 KB

installation.rst

File metadata and controls

118 lines (76 loc) · 3.72 KB
Raw

Installation

There are a couple of ways to install Modin. Most users will want to install with pip, but some users may want to build from the master branch on the GitHub repo.

Installing with pip

Stable version

Modin can be installed with pip. To install the most stable release run the following:

pip install modin

Release candidates

Before most major releases, we will upload a release candidate to If you would like to install a pre-release of Modin, run the following:

pip install --pre modin

These pre-releases are uploaded for dependencies and users to test their existing code to ensure that it still works. If you find something wrong, please raise an issue or email the bug reporter: bug_reports@modin.org.

Installing specific dependency sets

Modin has a number of specific dependency sets for running Modin on different backends or for different functionalities of Modin. Here is a list of dependency sets for Modin:

pip install "modin[dask]" # If you want to use the Dask backend

Installing from the GitHub master branch

If you'd like to try Modin using the most recent updates from the master branch, you can also use pip.

pip install git+https://github.com/modin-project/modin

This will install directly from the repo without you having to clone it! Please be aware that these changes have not made it into a release and may not be completely stable.

Windows

For installation on Windows, we recommend using Windows Subsystem for Linux (WSL). This will allow you to use Linux commands on your Windows machine.

One of our dependencies is Ray. Ray is not yet supported natively on Windows, so in order to install it you need to use the WSL if you are on Windows.

Once you've installed WSL, you can install Modin in the WSL bash shell just like you would on Linux or Mac:

pip install modin

Once you've done this, Modin will be installed. However, it is important to note that you must execute python, ipython and jupyter from the WSL application.

Dependencies

Currently, Modin depends on pandas version 0.23.4. The API of pandas has a tendency to change some with each release, so we pin our current version to the most recent version to take advantage of the newest additions. This also typically means better performance and more correct code.

Modin also depends on Ray. Ray is a task-parallel execution framework for parallelizing new and existing applications with minor code changes. Currently, we depend on the most recent Ray release: https://pypi.org/project/ray/.

Building Modin from Source

If you're planning on contributing to Modin, you will need to ensure that you are building Modin from the local repository that you are working off of. Occasionally, there are issues in overlapping Modin installs from pypi and from source. To avoid these issues, we recommend uninstalling Modin before you install from source:

pip uninstall modin

To build from source, you first must clone the repo:

git clone https://github.com/modin-project/modin.git

Once cloned, cd into the modin directory and use pip to install:

cd modin
pip install -e .