Getting Started¶

1. Prerequisites¶

  • Java (1.8)
  • Python (3.6, 3.7)

If you do not have Java, you might install it with your operating system’s package manager.

For example, on Ubuntu:

sudo apt-get install openjdk-8-jdk

macOS:

brew install openjdk

Windows (with Chocolately):

choco install openjdk

Jenv might be a helpful way to manage Java versions as well. If you’re on MacOS it’s also failry easy to set up with Homebrew.

2. Installation¶

The package can be installed from the Python Package Index (PyPi) with pip.

pip install srlearn

3. Test Installation¶

A simple test should be whether srlearn can be imported:

>>> import srlearn

If you’ve reached this point, you should be ready for the User Guide.