<commit_before># Installing Shogun

For certain systems, we offer pre-built packages of Shogun.
This is the easiest way to start using it.
For other cases, we describe how to build Shogun from source code.


# Quicklinks
 * [Ready-to-install packages](#binaries)
   - [Ubuntu](#ubuntu)
   - [Debian](#debian)
   - [Fedora](#fedora)
   - [MacOS](#mac)
   - [Windows](#windows)
 * [Docker images](#docker)
 * [Integration with interface languages](#language)
   - [Python](#pipy)
 * [Compiling manually](#manual)
   - [Requirements](#manual-requirements)
   - [Basics](#manual-basics)
   - [Interfaces](#manual-interfaces)
   - [Examples](#manual-examples)
   - [Problems](#manual-problems)
   - [CMake tips](#manual-cmake)
   - [Customized Python](#manual-python)
   - [Winows](#manual-windows)

## Ready-to-install packages <a name="binaries"></a>

### Ubuntu ppa <a name="ubuntu"></a>
We are working on integrating Shogun with Debian/Ubuntu.
In the meantime, we offer a [prepackaged ppa](https://launchpad.net/~shogun-toolbox/+archive/ubuntu/stable).
These currently do contain the C++ library and Python bindings.
Add this to your system as

    sudo add-apt-repository ppa:shogun-toolbox/stable
    sudo apt-get update

Then, install as

    sudo apt-get install libshogun17

The Python (2) bindings can be installed as

    sudo apt-get install python-shogun

In addition to the latest stable release, we offer [nightly builds](https://launchpad.net/~shogun-toolbox/+archive/ubuntu/nightly) of our development branch.

### Debian <a name="debian"></a>
Latest packages for Debian jessie are available in our own repository at [http://apt.shogun.ml](http://apt.shogun.ml).
We provide both the stable and nightly packages, currenlty only for amd64 architecture.
In order to add the stable packages to your system, simply run the following commands

    sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3DD2174ACAB30365
    echo "deb http://apt.shogun.ml/ jessie main" | sudo tee /etc/apt/sources.list.d/shogun-toolbox.list  > /dev/null
    sudo apt-get update

After this just simply install the shogun library

    sudo apt-get install libshogun17

The nightly packages are available in the `nightly` component, i.e. `deb http://apt.shogun.ml/ jessie nightly`

### Fedora <a name="fedora"></a>
Shogun is part of [Fedora 25](https://admin.fedoraproject.org/pkgdb/package/rpms/shogun/).
Install as

    sudo dnf install shogun


### MacOS <a name="mac"></a>
Shogun is part of [homebrew-science](https://github.com/Homebrew/homebrew-science).
Install the latest stable version as

    sudo brew install shogun

### Windows <a name="windows"></a>
Shogun natively compiles under Windows using MSVC, see the [AppVeyor CI build](https://ci.appveyor.com/project/vigsterkr/shogun) and the [Windows section](#manual-windows)
We currently do not support a binary installer.
If you are interested in packaging, documenting, or contributing otherwise, please contact us.

## Docker images <a name="docker"></a>
You can run Shogun in [our own cloud](cloud.shogun.ml) or set up your own using our
[Docker images](https://hub.docker.com/r/shogun/shogun/) as:<commit_msg>Update install instructions for homebrew.<commit_after># Installing Shogun

For certain systems, we offer pre-built packages of Shogun.
This is the easiest way to start using it.
For other cases, we describe how to build Shogun from source code.


# Quicklinks
 * [Ready-to-install packages](#binaries)
   - [Ubuntu](#ubuntu)
   - [Debian](#debian)
   - [Fedora](#fedora)
   - [MacOS](#mac)
   - [Windows](#windows)
 * [Docker images](#docker)
 * [Integration with interface languages](#language)
   - [Python](#pipy)
 * [Compiling manually](#manual)
   - [Requirements](#manual-requirements)
   - [Basics](#manual-basics)
   - [Interfaces](#manual-interfaces)
   - [Examples](#manual-examples)
   - [Problems](#manual-problems)
   - [CMake tips](#manual-cmake)
   - [Customized Python](#manual-python)
   - [Winows](#manual-windows)

## Ready-to-install packages <a name="binaries"></a>

### Ubuntu ppa <a name="ubuntu"></a>
We are working on integrating Shogun with Debian/Ubuntu.
In the meantime, we offer a [prepackaged ppa](https://launchpad.net/~shogun-toolbox/+archive/ubuntu/stable).
These currently do contain the C++ library and Python bindings.
Add this to your system as

    sudo add-apt-repository ppa:shogun-toolbox/stable
    sudo apt-get update

Then, install as

    sudo apt-get install libshogun17

The Python (2) bindings can be installed as

    sudo apt-get install python-shogun

In addition to the latest stable release, we offer [nightly builds](https://launchpad.net/~shogun-toolbox/+archive/ubuntu/nightly) of our development branch.

### Debian <a name="debian"></a>
Latest packages for Debian jessie are available in our own repository at [http://apt.shogun.ml](http://apt.shogun.ml).
We provide both the stable and nightly packages, currenlty only for amd64 architecture.
In order to add the stable packages to your system, simply run the following commands

    sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 3DD2174ACAB30365
    echo "deb http://apt.shogun.ml/ jessie main" | sudo tee /etc/apt/sources.list.d/shogun-toolbox.list  > /dev/null
    sudo apt-get update

After this just simply install the shogun library

    sudo apt-get install libshogun17

The nightly packages are available in the `nightly` component, i.e. `deb http://apt.shogun.ml/ jessie nightly`

### Fedora <a name="fedora"></a>
Shogun is part of [Fedora 25](https://admin.fedoraproject.org/pkgdb/package/rpms/shogun/).
Install as

    sudo dnf install shogun


### MacOS <a name="mac"></a>
Shogun is part of [homebrew-science](https://github.com/Homebrew/homebrew-science).
Install the latest stable version as

    sudo brew install homebrew/science/shogun

### Windows <a name="windows"></a>
Shogun natively compiles under Windows using MSVC, see the [AppVeyor CI build](https://ci.appveyor.com/project/vigsterkr/shogun) and the [Windows section](#manual-windows)
We currently do not support a binary installer.
If you are interested in packaging, documenting, or contributing otherwise, please contact us.

## Docker images <a name="docker"></a>
You can run Shogun in [our own cloud](cloud.shogun.ml) or set up your own using our
[Docker images](https://hub.docker.com/r/shogun/shogun/) as:
{'fraction_non_alphanumeric': 0.122669591101363, 'fraction_numerical': 0.005953313488955037, 'mean_word_length': 4.224222585924713, 'pattern_counts': {'":': 0, '<': 31, '<?xml version=': 0, '>': 33, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1266336', 'n_tokens_mistral': 2191, 'n_tokens_neox': 1962, 'n_words': 651}