.. _pymepix_with_no_camera:

Install Pymepix and Pymepixviewer
=================================

Required Software:

- Python
- Git
- Some way of installing the requirements.txt in a virtual environment (Here we will use ``uv`` quelle, alternative ``pip install .``)

You can change current directory of a terminal with ``cd relative/path/to/where/you/want/to/go``

You can show the contents of the current directory with ``ls``

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 next chapter to make sure everything works

Done

Usage without hardware camera
=============================

1. Open a terminal and navigate to the folder into which the repositories were cloned, then run ``source ~/timepix/.venv/bin/activte; cd timepix/pymepix/pympix/utils``
2. run ``python spidrDummyTCP.py``
3. wait

Output should be similar to:

.. code-block::

   Config file:  /path/to/your/timepix/pymepix/pymepix/config/default.yaml
   started...

This terminal should be left open while pymepix is used

4. Open another terminal and navigate to the folder into which the repositories were cloned, then run ``source ~/timepix/.venv/bin/activte``
5. run ``pymepixviewer``
6. Wait

Now a new window should open, with a couple ui elements. The second terminal should also be left open

To test if evething works:

7. Open a third terminal, run ``source ~/timepix/.venv/bin/activte; cd timepix/pymepix/pympix/utils``
8. Run ``python spidrDummyUDP.py --filename="../../tests/files/ion_2595_20240130-1443.raw"``

Some new stuff should now be visible in the pymepixviewer.

Done!

Result of the test after step 8:

.. image:: pymepixviewer_test.png
   :alt: Title