Metadata-Version: 2.1
Name: data-slicer
Version: 0.0.11
Summary: Tools for quick visualization of three dimensional datasets.
Home-page: https://github.com/kuadrat/data_slicer.git
Author: Kevin Kramer
Author-email: kevin.kramer@uzh.ch
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: matplotlib (>=3.1.1)
Requires-Dist: numpy (>=1.17.3)
Requires-Dist: PyOpenGL (>=3.1.1a1)
Requires-Dist: pyqtgraph (>=0.11.0)
Requires-Dist: PyQt5 (>=5.13.2)
Requires-Dist: qtconsole (>=4.6.0)

# Data slicer

The `data-slicer` package offers fast 3D data visualization tools with plugin capabilites.

![](https://raw.githubusercontent.com/kuadrat/data_slicer/master/screenshots/pit_demo.gif)

The package was developed to deal with the high data throughput of modern measurement 
instruments, where quick visualizations and preliminary analyses are necessary to guide
the direction of a measurement session.

## Documentation

This README just gives a minimal overview.
For more information, guides, examples and more, visit the documentation which is hosted 
by the friendly people over at ReadTheDocs.org:
https://data-slicer.readthedocs.io/en/latest/

## Installation

`data-slicer` should run on all platforms that support python and has been 
shown to run on Windows, macOS ans Linux.

The package can be installed from [PyPI](https://pypi.org/project/data-slicer/) 
using `pip install data_slicer`.
It is recommended to do this from within some sort of virtual environment.
Visit the documentation for more detailed instructions:
https://data-slicer.readthedocs.io/en/latest/installation.html

## Contributing

If you are familiar with the workflow on github, feel free to go ahead and create a pull
request or open an issue.
If you are unsure of what that means but are willing to contribute, contact Kevin Kramer
via email: kevin.kramer@uzh.ch

### Plugins

If you have created a PIT plugin, feel free to add it to the list below, 
either via pull request or through an email (see above).

| Plugin Name (link) | Description | 
| ------------------ | ----------- |
| [ds-arpes-plugin](https://www.pluralsight.com/guides/working-tables-github-markdown) | tools for angle-resolved photoelectron spectroscopy (ARPES) | 



