Getting Started: Install & Verify
=================================

.. warning::
   The information below is incomplete and requires extra work. Use it at your own risk!

To use **Emmi Framework** you have to clone the repository from GitHub or install it as a Python package.
This documentation will guide you through this process.

We assume basic knowledge of Git, Python, as well as Unix systems.

Installing from the repo
------------------------

To get started, clone the repo to your machine:

.. code-block:: bash

   git clone git@github.com:Emmi-AI/core.git

Navigate to your fresh repo, here we will assume the working path as `/home/user/repos/core`, and use `uv` to set up
the project.

Optionally setup Python using uv (for more options consult the official documentation):

.. code-block:: bash

   uv python install

Create a virtual environment with relevant packages:

.. code-block:: bash

   uv venv                    # create a default virtual environment under the default .venv folder
   source .venv/bin/activate  # activate your newly created environment in your terminal
   pre-commit install         # install git pre-commit hooks if you plan to contribute to the code base

Verifying the Installation
--------------------------

See if the installation was successful by running the tests:

.. code-block:: bash

   pytests -q tests/

.. warning::
   The information below is for reference only as the CLI is not final yet.

.. code-block:: bash

   emmi-workspace --version
   # Emmi SDK version 1.0.0

   emmi-workspace check
   # ✔ PyTorch found.
   # ✔ Installation is correct.