Metadata-Version: 2.4
Name: magscope
Version: 0.2.1
Summary: Python framework for live data acquisition and analysis in magnetic tweezers microscopy
Author-email: James London <7jameslondon@gmail.com>
License-Expression: GPL-3.0
Project-URL: Homepage, https://github.com/7jameslondon/MagScope
Project-URL: Source, https://github.com/7jameslondon/MagScope
Project-URL: Documentation, https://magscope.readthedocs.io
Project-URL: Issues, https://github.com/7jameslondon/MagScope/issues
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: license
Requires-Dist: numpy>=1.26
Requires-Dist: scipy>=1.11.1
Requires-Dist: matplotlib
Requires-Dist: tifffile
Requires-Dist: PyYAML
Requires-Dist: magtrack>=0.7
Requires-Dist: PyQt6
Provides-Extra: cpu
Provides-Extra: cu11
Requires-Dist: cupy-cuda11x>=12.0; extra == "cu11"
Provides-Extra: cu12
Requires-Dist: cupy-cuda12x>=13.0; extra == "cu12"
Provides-Extra: cu13
Requires-Dist: cupy-cuda13x>=13.0; extra == "cu13"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx>=7; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx-autoapi; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Dynamic: license-file

<h1 align="center">
<img src="https://raw.githubusercontent.com/7jameslondon/MagScope/refs/heads/master/assets/logo.png" width="300">
</h1><br>

[![PyPi](https://img.shields.io/pypi/v/magscope.svg)](https://pypi.org/project/magscope/)
[![Docs](https://img.shields.io/readthedocs/magscope/latest.svg)](https://magscope.readthedocs.io)
[![Python package](https://github.com/7jameslondon/MagScope/actions/workflows/python-package.yml/badge.svg)](https://github.com/7jameslondon/MagScope/actions/workflows/python-package.yml)
[![Paper](https://img.shields.io/badge/DOI-10.1101/2025.10.31.685671-blue)](https://doi.org/10.1101/2025.10.31.685671)

[MagScope](https://github.com/7jameslondon/MagScope) is a Python-based application for live data acquisition and analysis in [magnetic tweezers microscopy](https://doi.org/10.1007/978-1-0716-3377-9_18). 

* Fast, high-throughput, and high-resolution
* GUI - includes a clean simple GUI (Graphical User Interface)
* Demo - Launches by default with a simulated camera so you can try it without microscope hardware connected
* Automation - Create simple Python scripts to automate data-collection and motor movement for long/complex experiments.
* XYZ-Lock - Enable XY- and/or Z-Lock to keep beads centered and in focus for long experiments
* Customizable - Easily add your lab's hardware and implement custom features
* CPU or GPU tracking of beads via [MagTrack](https://github.com/7jameslondon/MagTrack)

## 🚀 Getting Started
[👉 👉 👉 Get Started Here 👈 👈 👈](https://magscope.readthedocs.io)

## 📖 Documnetation
View the full guide to MagScope at [magscope.readthedocs.io](https://magscope.readthedocs.io)

## 💬 Support
Report issues and make requests on the [GitHub issue tracker](https://github.com/7jameslondon/MagScope/issues)<br><br>
Having trouble? Need help? Have suggestions? Want to contribute?<br>
Email us at magtrackandmagscope@gmail.com

## ⚒ Quick Start (Advanced)
<details>
  <summary>Click to expand</summary>

Easy CPU only install with pip:
```
pip install magscope
```
Launch the demo with:
```
import magscope

scope = magscope.MagScope()
scope.start()
```
More details on how to install with GPU-acceleration, connect your own camera and more are in the [documentation](https://magscope.readthedocs.io)!
</details>
