Metadata-Version: 2.3
Name: mosaic-gui
Version: 1.0.1.post0
Summary: mosaic
License: GPL
Author: Valentin Maurer
Author-email: valentin.maurer@embl-hamburg.de
Requires-Python: >=3.11,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: Pillow
Requires-Dist: PyQt6 (==6.7.1)
Requires-Dist: imageio
Requires-Dist: imageio-ffmpeg
Requires-Dist: importlib_resources
Requires-Dist: libigl (==2.5.1)
Requires-Dist: matplotlib
Requires-Dist: numpy (>=1.22.2,<2.0)
Requires-Dist: open3d (>=0.18.0)
Requires-Dist: pyfqmr (>=0.3.0)
Requires-Dist: pymeshlab (>=2023.12.post2)
Requires-Dist: pyqtgraph (>=0.13.3)
Requires-Dist: pytme (>=0.2.6)
Requires-Dist: qtawesome
Requires-Dist: scipy (>=1.14.1)
Requires-Dist: tqdm (>=4.67.1)
Requires-Dist: vtk (>=9.3.1)
Requires-Dist: zmesh (>=1.8.0)
Project-URL: Homepage, https://github.com/KosinskiLab/mosaic
Project-URL: Repository, https://github.com/KosinskiLab/mosaic
Description-Content-Type: text/markdown

# Mosaic

[![Build Status](https://img.shields.io/github/actions/workflow/status/KosinskiLab/mosaic/main.yml?label=CI)](https://github.com/KosinskiLab/mosaic/actions)
[![PyPI](https://img.shields.io/pypi/v/mosaic-gui.svg)](https://pypi.org/project/mosaic-gui/)
[![License: GPL v2](https://img.shields.io/badge/License-GPL_v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)

**[Documentation](https://kosinskilab.github.io/mosaic/)** | **[Installation](https://kosinskilab.github.io/mosaic/tutorial/installation.html)**


Mosaic translates 3D electron microscopy data into simulation-ready models of biomembranes.

![IAV Example](docs/_static/tutorial/iav_workflow/mosaic_workflow.png)

To achieve this, the Mosaic ecosystem unifies membrane segmentation, mesh generation, protein identification, and multi-scale simulation into a graphical user interface.

![Mosaic Workflow](docs/_static/workflow.png)

## Quick Start

Mosaic requires Python 3.11 or higher.

```bash
pip install mosaic-gui
mosaic &
```

For detailed installation instructions, see our [Installation Guide](https://kosinskilab.github.io/mosaic/tutorial/installation.html).

## Helfrich Monte Carlo Flexible Fitting (HMFF)

HMFF refines membrane mesh models by uniquely integrating experimental density data into membrane simulations, enabling experimental observations and physical properties to jointly determine membrane conformations. HMFF is implemented in FreeDTS and integrated into the Mosaic workflow. For usage instructions, see our [IAV tutorial](https://kosinskilab.github.io/mosaic/tutorial/workflows/iav.html), and for technical details, consult the [FreeDTS User Manual](https://github.com/weria-pezeshkian/FreeDTS/wiki/User-Manual-for-version-2).


## How to Cite

If you use Mosaic in your research, please [cite](https://www.biorxiv.org/content/10.1101/2025.05.24.655915v1):

```bibtex
@article{Maurer2025.05.24.655915,
	author = {Maurer, Valentin J. and Siggel, Marc and Jensen, Rasmus K. and Mahamid, Julia and Kosinski, Jan and Pezeshkian, Weria},
	journal = {bioRxiv},
	title = {Helfrich Monte Carlo Flexible Fitting: physics-based, data-driven cell-scale simulations},
	doi = {10.1101/2025.05.24.655915},
	year = {2025}
}
```
