File size: 2,572 Bytes
d6ea71e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
===================
Installation
===================
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.
Install Python
==============
Being a Python library, socceraction requires Python.
Currently, socceraction supports Python version 3.9 -- 3.12.
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.
>>>
Install socceraction
====================
You've got two options to install socceraction.
.. _installing-official-release:
Installing an official release with ``pip``
-------------------------------------------
This is the recommended way to install socceraction. Simply run this simple command in your terminal of choice:
.. code-block:: console
$ python -m pip install socceraction
You might have to install pip first. The easiest method is to use the `standalone pip installer`_.
.. _pip: https://pip.pypa.io/
.. _standalone pip installer: https://pip.pypa.io/en/latest/installing/#installing-with-get-pip-py
.. _installing-development-version:
Installing the development version
----------------------------------
Socceraction is actively developed on GitHub, where the code is
`always available <https://github.com/ML-KULeuven/socceraction>`_.
You can easily install the development version with:
.. code-block:: console
$ 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:
.. code-block:: console
$ git clone git://github.com/ML-KULeuven/socceraction.git
Or, download the `zipball <https://github.com/ML-KULeuven/socceraction/archive/master.zip>`_:
.. code-block:: console
$ 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:
.. code-block:: console
$ cd socceraction
$ python -m pip install -e .
Verifying
=========
To verify that socceraction can be seen by Python, type ``python`` from your shell.
Then at the Python prompt, try to import socceraction:
.. parsed-literal::
>>> import socceraction
>>> print(socceraction.__version__)
|