# MiniMOKE

UI interface for the miniMOKE experimental setup.

## Requirements

This project requires a conda or miniconda environment with python3.6 64bit or newer.
To create an environment, just run: 
```bash
conda create --name MOKE python=3.11 
```
And you can check the list of available environments using:
```bash
conda env list
```

Then, install the required modules:
```bash
conda install -c conda-forge pylablib
conda install -c conda-forge pythonnet
conda install pyinstaller
pip install pymeasure
pip install nidaqmx
pip install markdown
pip install qdarkstyle
pip install pyft232
```

## How to use

Please use the batch scripts in the `scripts` folder to run the program if you are unware of the correct environment to use.

## Code breakdown

The project structure is as follows:

- `minimoke/libs`: This directory contains library files, such as `MagnetPhysik.Usb.dll`, which are used by the project.

- `minimoke/.gitignore`: This file is used by Git to determine which files and directories to ignore in the project.

- `minimoke/configs`: This directory contains configuration files (INI files) for the stages, procedures, and DAC.

- `minimoke/scripts`: This directory contains build and debug scripts, as well as the PyInstaller JSON configuration file.

- `minimoke/doc`: This directory contains the user manual for the project.

- `minimoke/assets`: This directory contains image files and icons used by the project.

- `minimoke/__main__.py`: The main entry point of the project.

- `minimoke/src`: This directory contains source code files for the project. 

    - `minimoke/src/procedures`: This directory contains the source code for various experimental procedures including y-sweep, b-sweep, x-sweep, and xy-sweep.

    - `minimoke/src/ui`: This directory contains the source code for the User Interface (UI) including the main UI, user manual tab UI, live tab UI, and motors tab UI.

    - `minimoke/src/classes`: This directory contains the source code for various classes used in the project including the status bar class, DAC class, stage class, config handler class, and hall sensor class.