Metadata-Version: 2.4
Name: derzug
Version: 0.0.10
Summary: A DAS application for interactive visualizations.
Author-email: Derrick Chambers <chambers.ja.derrick@gmail.com>
License-Expression: GPL-3.0-or-later
Project-URL: Bug Tracker, https://github.com/DASDAE/derzug/issues
Project-URL: Documentation, https://github.com/DASDAE/derzug
Project-URL: Homepage, https://github.com/DASDAE/derzug
Project-URL: Source, https://github.com/DASDAE/derzug
Keywords: geophysics,distributed-acoustic-sensing
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: X11 Applications :: Qt
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dascore>=0.1.15
Requires-Dist: PyQt6!=6.8.*
Requires-Dist: pyqtgraph
Requires-Dist: orange3
Requires-Dist: typer
Provides-Extra: test
Requires-Dist: coverage<8,>=7.4; extra == "test"
Requires-Dist: pytest-cov>=4; extra == "test"
Requires-Dist: prek; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-qt; extra == "test"
Provides-Extra: dev
Requires-Dist: derzug[test]; extra == "dev"
Dynamic: license-file

# DerZug

> [!WARNING]
> ## Experimental Software
> DerZug is an early-stage proof of concept.
> Expect bugs, incomplete behavior, data-loss risks, and frequent breaking changes.
> The creators make no promises of further development or maintenance.

<img src="https://raw.githubusercontent.com/dasdae/derzug/main/docs/static/logo_v2.png" width="500">

DerZug is powered by the [Orange3](https://orangedatamining.com/),
[PyQtGraph](https://www.pyqtgraph.org/), and [DASDAE](https://dasdae.org)
ecosystems.

It's goal is to allow users to **interactively create, debug, and share reproducible DFOS workflows**.

It can be launched as a standalone application, or used for interactive exploration (in code).

## Installation

Install from PyPI with:
```bash
pip install derzug
```

or mamba/conda:
```bash
mamba install derzug
```

> [!TIP]
> The PyQT stack can have some rough installation edges. The smoothest experience is generally on Python 3.13 with mamba.

## Getting start

To get a quick introduction to DerZug, launch it in demo mode and load the quickstart workflow:

```bash
derzug --demo
```

DerZug can also be used interactively in code: 

```python
import dascore as dc

patch = dc.get_example_patch("example_event_2")

# Launches a waterfall window for viewing a patch 
patch.zug.waterfall()
```

