Metadata-Version: 2.4
Name: use-the-force
Version: 0.1.1
Summary: Code for practicum Use the Force at Vrije Universteit Amsterdam.
Project-URL: source, https://github.com/NatuurkundePracticumAmsterdam/Use-the-Force
Project-URL: issues, https://github.com/NatuurkundePracticumAmsterdam/Use-the-Force/issues
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: pyserial
Requires-Dist: PySide6
Requires-Dist: pyqtgraph
Dynamic: license-file

﻿# Use the Force
[![GitHub license](https://img.shields.io/github/license/NatuurkundePracticumAmsterdam/Use-the-Force
)](LICENSE)
[![PyPI - Version](https://img.shields.io/pypi/v/use_the_force)
](https://pypi.org/project/use_the_force/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/use_the_force)](https://pypi.org/project/use_the_force/)


Python package for physics practicum at Vrije Universiteit Amsterdam.

## Features
Allows for communication with the M5Din Meter that is used within the practicum.\
Comes bundled with a GUI, that includes various settings when using the M5Din Meter.

## Using the GUI
The GUI can be called upon with the `start()` function in `use_the_force.gui`. 

Or by rewriting the `start()` function yourself:
```py
import sys
from PySide6 import QtWidgets
import use_the_force.gui as gui

app = QtWidgets.QApplication(sys.argv)
ui = gui.UserInterface()
ui.show()
ret = app.exec_()
sys.exit(ret)
```

## Additional Info
#### Motorstage speed:
`SV(120)` = 2 mm/s\
`SV(60)` = 1 mm/s

Range: `[1,120]`

## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
