This repository hosts the user interface software for the MiniMOKE experimental setup.
## Requirements
## Prerequisites
To run this project, you'll need a Conda or Miniconda environment with Python 3.6 (64-bit) or newer. Create an environment by executing the following command:
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:
To view the list of available environments, run:
```bash
conda env list
```
Then, install the required modules:
Subsequently, install the necessary modules:
```bash
conda install-c conda-forge pylablib
conda install-c conda-forge pythonnet
...
...
@@ -26,32 +29,32 @@ pip install qdarkstyle
pip install pyft232
```
## How to use
## Usage
Please use the batch scripts in the `scripts` folder to run the program if you are unware of the correct environment to use.
If you're unsure of the correct environment to use, please run the program using the batch scripts located in the `scripts` folder which will automatically run the correct file using the `NOKE` env.
## Code breakdown
## Code Structure
The project structure is as follows:
Here's a breakdown of the project structure:
-`minimoke/libs`: This directory contains library files, such as `MagnetPhysik.Usb.dll`, which are used by the project.
-`minimoke/libs`: Houses the project's library files, such as `MagnetPhysik.Usb.dll`.
-`minimoke/.gitignore`: This file is used by Git to determine which files and directories to ignore in the project.
-`minimoke/.gitignore`: Git uses this file to identify which files and directories to exclude from the project.
-`minimoke/configs`: This directory contains configuration files (INI files) for the stages, procedures, and DAC.
-`minimoke/configs`: Stores the configuration files (INI files) for stages, procedures, and DAC.
-`minimoke/scripts`: This directory contains build and debug scripts, as well as the PyInstaller JSON configuration file.
-`minimoke/scripts`: Contains the build and debug scripts, as well as the PyInstaller JSON configuration file.
-`minimoke/doc`: This directory contains the user manual for the project.
-`minimoke/doc`: Contains the user manual for the software.
-`minimoke/assets`: This directory contains image files and icons used by the project.
-`minimoke/assets`: Contains the image files and icons utilized by the software.
-`minimoke/__main__.py`: The main entry point of the project.
-`minimoke/__main__.py`: Serves as the primary entry point for the software.
-`minimoke/src`: This directory contains source code files for the project.
-`minimoke/src`: Holds the source code files for the software, divided into the following directories:
- `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/procedures`: Contains source code for different 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/ui`: Contains 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.
\ No newline at end of file
-`minimoke/src/classes`: Contains source code for various classes used in the software, including StatusBar class, DAC class, Stage class, ConfigHandler class, and HallSensor class.
