.. _install_pymepix:

Install Pymepix with Pymepixviewer
==================================

1. Create new folder (e.g. ``timepix``)
2. Open folder from Step 1 in terminal (e.g. ``cd timepix``)
3. Clone both Pymepix and Pymepixviewer into the new folder into two separate repositories

.. code-block:: sh

   git clone https://gitlab.desy.de/CMI/CMI-public/pymepix.git
   git clone https://gitlab.desy.de/CMI/CMI-public/pymepix-viewer.git

4. Create a virtual environment by running ``uv venv`` in the terminal
5. Activate the virtual environment in the terminal by running ``source .venv/bin/activate``
6. Install the pymepix repository by running ``cd pymepix; uv pip install .``
7. Run ``uv pip install pyqt5``
8. Install Pymepixviewer by running ``cd ../pymepixviewer; uv pip install .``
9. Install git lfs by running ``git lfs install`` and ``git lfs pull``
10. Run a simple test as described in the chapter "Use Pymepix without camera" to make sure everything works

Done