Installing

Warning

It is recommended not to install directly into your operating system’s Python using sudo since it may break your system. Instead, you should install Anaconda, which is a Python distribution that makes installing Python packages much easier or use virtualenv or venv.

Short version

  • Anaconda users: conda install -c conda-forge vaex
  • Regular Python users using virtualenv: pip install --pre vaex
  • Regular Python users (not recommended): pip install --user --pre vaex
  • System install (not recommended): sudo pip install --pre vaex

Longer version

If you don’t want all packages installed, do not install the vaex package. The vaex package is a meta packages that depends on all other vaex packages so it will instal them all, but if you don’t need astronomy related parts (vaex-astro), or don’t care about distributed (vaex-distributed), you can leave out those packages. Copy paste the following lines and remove what you do not need:

  • Regular Python users: pip install vaex-core vaex-viz vaex-server vaex-ui vaex-hdf5 vaex-astro vaex-distributed
  • Anaconda users: conda install -c conda-forge vaex-core vaex-viz vaex-server vaex-ui vaex-hdf5 vaex-astro vaex-distributed

When installing vaex-ui it does not install PyQt4, PyQt5 or PySide, you have to choose yourself and installing may be tricky. If running pip install PyQt5 fails, you may want to try your favourite package manager (brew, macports) to install it instead. You can check if you have one of these packages by running:

  • python -c "import PyQt4"
  • python -c "import PyQt5"
  • python -c "import PySide"

For developers

If you want to work on vaex for a Pull Request from the source, use the following reciple:

  • git clone https://github.com/maartenbreddels/vaex
  • cd vaex
  • install using:
  • pip install -e . (again, use (ana)conda or virtualenv/venv)
  • If you want to do a PR
  • git remote rename origin upstream
  • (now fork on github)
  • git remote add origin https://github.com/yourusername/vaex/
  • … edit code … (or do this after the next step)
  • git checkout -b feature_X
  • git commit -a -m "new: some feature X"
  • git push origin feature_X
  • git checkout master
  • Get your code in sync with upstream
  • git checkout master
  • git fetch upstream
  • git merge upstream/master