Installation Guide

There are different ways to install scikit-physlearn. They include:

• Installing the latest stable release hosted on PyPI.

• Building the package from source.

Installing from PyPI

The scikit-physlearn pre-built binary wheel is available from Python Package Index (PyPI). You may download and install it by running:

pip install scikit-physlearn

Building from source

Use Git to clone the latest source from the scikit-physlearn repository on Github:

git clone git://github.com/a-wozniakowski/scikit-physlearn.git
cd scikit-physlearn

Then, build the project with pip in editable mode:

pip install -e

The global editable option -e invokes the setuptools develop mode: setup.py develop. In other words, the build places a scikit_physlearn.egg-info directory adjacent to the code and resources.

Moreover, all of the dependencies are automatically managed by the build:

numpy
scipy
scikit-learn
pandas
shap
ipython
bayesian-optimization
catboost
xgboost
lightgbm
mlxtend
joblib
threadpoolctl
cython
python-Levenshtein