Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 2.08 KiB
Newer Older
esarrey's avatar
Batch scripts  
esarrey committed
1 
# MiniMOKE
Eliott Sarrey's avatar
Initial commit
Eliott Sarrey committed
2
esarrey's avatar
Change to Qt  
esarrey committed
3 4 5 6 
UI interface for the miniMOKE experimental setup.

## Requirements
esarrey's avatar
Readd missing code of DAC  
esarrey committed
7 
This project requires a conda or miniconda environment with python3.6 64bit or newer.
esarrey's avatar
Autopytoexe  
esarrey committed
8 9 10 11 12 13 14 15 
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
```
esarrey's avatar
First test pymeasure  
esarrey committed
16
esarrey's avatar
Autopytoexe  
esarrey committed
17 
Then, install the required modules:
esarrey's avatar
First test pymeasure  
esarrey committed
18 
```bash
esarrey's avatar
Hall probe  
esarrey committed
19 20 
conda install -c conda-forge pylablib
conda install -c conda-forge pythonnet
esarrey's avatar
Autopytoexe  
esarrey committed
21 
conda install pyinstaller
esarrey's avatar
First test pymeasure  
esarrey committed
22 23 
pip install pymeasure
pip install nidaqmx
esarrey's avatar
Batch scripts  
esarrey committed
24 
pip install markdown
esarrey's avatar
Autopytoexe  
esarrey committed
25 26 
pip install qdarkstyle
pip install pyft232
esarrey's avatar
Todo list  
esarrey committed
27 
```
esarrey's avatar
Batch scripts  
esarrey committed
28 29 30 

## How to use
esarrey's avatar
Full readme  
esarrey committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 
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.