Metadata-Version: 2.1
Name: QZFM
Version: 0.0.3
Summary: Python class for serial communication with QuSpin Zero Field Magnetometer
Author-email: Derek Fujimoto <dfujimoto@triumf.ca>
Project-URL: Homepage, https://github.com/ucn-triumf/QZFM
Project-URL: Bug Tracker, https://github.com/ucn-triumf/QZFM/issues
Keywords: QZFM,QuSpin,Magnetometer,Zero Field
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pyserial
Requires-Dist: datetime
Requires-Dist: tqdm
Requires-Dist: pandas

# QuSpin Zero Field Magnetometer DAQ

<img src="https://img.shields.io/pypi/v/QZFM?style=flat-square"/> <img src="https://img.shields.io/pypi/format/QZFM?style=flat-square"/> <img src="https://img.shields.io/github/languages/top/ucn-triumf/QZFM?style=flat-square"/> <img src="https://img.shields.io/github/languages/code-size/ucn-triumf/QZFM?style=flat-square"/> <img src="https://img.shields.io/pypi/l/QZFM?style=flat-square"/> <img src="https://img.shields.io/github/last-commit/ucn-triumf/QZFM?style=flat-square"/>

Read and control QuSpin magnetometer (unofficial)

Uses [QZFM commands] to send/receive signals via the [pySerial](https://pyserial.readthedocs.io/) module. See also [this guide](https://quspin.com/products-qzfm-gen2-arxiv/qzfm-quick-start-guide/) for more info on setup for the QuSpin.

This has been tested on the QuSpin Triaxial sensor.

## [See API documentation here.](./docs/src/QZFM.md)

Documentation generated with [`handsdown`](https://github.com/vemel/handsdown)

[QZFM commands]:https://quspin.com/products-qzfm-gen2-arxiv/qzfm-command-list/
