Before you can use socceraction, you’ll need to get it installed. This guide will guide you to a minimal installation that’ll work while you walk through the introduction.
Being a Python library, socceraction requires Python. Currently, socceraction supports Python version 3.8 – 3.11. Get the latest version of Python at https://www.python.org/downloads/ or with your operating system’s package manager.
You can verify that Python is installed by typing
python from your shell;
you should see something like:
Python 3.x.y [GCC 4.x] on linux Type "help", "copyright", "credits" or "license" for more information. >>>
You’ve got two options to install socceraction.
Installing an official release with
This is the recommended way to install socceraction. Simply run this simple command in your terminal of choice:
$ python -m pip install socceraction
You might have to install pip first. The easiest method is to use the standalone pip installer.
Installing the development version#
Socceraction is actively developed on GitHub, where the code is always available. You can easily install the development version with:
$ pip install git+https://github.com/ML-KULeuven/socceraction.git
However, to be able to make modifications in the code, you should either clone the public repository:
$ git clone git://github.com/ML-KULeuven/socceraction.git
Or, download the zipball:
$ curl -OL https://github.com/ML-KULeuven/socceraction/archive/master.zip
Once you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:
$ cd socceraction $ python -m pip install -e .
To verify that socceraction can be seen by Python, type
python from your shell.
Then at the Python prompt, try to import socceraction:
>>> import socceraction >>> print(socceraction.__version__)