Metadata-Version: 2.4
Name: datatour
Version: 0.2.9
Summary: Seeing is important. `datatour` - allows you to see your data in it's native dimension. Currently implemented as a `plotly` scatter plot projected from it's original dimension in the 2D on the screen with timeline animation inspired by GrandTour and common sense. 
Project-URL: homepage, https://github.com/neworldemancer/datatour_pkg
Project-URL: repository, https://github.com/neworldemancer/datatour_pkg
Author-email: Mykhailo Vladymyrov <neworldemancer@gmail.com>
License: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Requires-Python: >=3.8
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: plotly
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pdbpp; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: rich; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

DataTour
---
# datatour

[![License](https://img.shields.io/pypi/l/datatour.svg?color=green)](https://github.com/neworldemancer/datatour_pkg/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/datatour.svg?color=green)](https://pypi.org/project/datatour)
[![Python Version](https://img.shields.io/pypi/pyversions/datatour.svg?color=green)](https://python.org)
[![CI](https://github.com/neworldemancer/datatour_pkg/actions/workflows/ci.yml/badge.svg)](https://github.com/neworldemancer/datatour_pkg/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/neworldemancer/datatour_pkg/branch/main/graph/badge.svg)](https://codecov.io/gh/neworldemancer/datatour_pkg)

DataTour
---

Seeing is important. `datatour` - allows you to see your data in its native dimension.
Currently implemented as a `plotly` scatter plot projected from its original dimension in the 2D on the screen with timeline animation inspired by GrandTour and common sense.



---
Installation
---

Available via pip:
```
pip install datatour
```

---
Usage

If you have array of feature vectors `f`: `shape(shape)==(n_smpl, n_dim)`, you can create data tour object, and display it:

```
from datatour import DataTour as dt

ndv = dt(f)
ndv.display()
```
By default, selects randomly `n_subsample=500` samples for efficiency reason.

To visualize vector field `vf` of the same dimension (in the same feature space):

```
ndv = dt(f, vf)
ndv.display_quiver(color='z_scaled')
```

Also check examples:

```
dt().display()
```
![cube](https://raw.githubusercontent.com/neworldemancer/datatour_pkg/master/media/cube.png)


```
ndv = dt(example='sphere', n_subsample=0)
ndv.display(color='z_scaled')
```
![sphere](https://raw.githubusercontent.com/neworldemancer/datatour_pkg/master/media/sphere.png)



---
Installation
---

Available via pip:
```
pip install datatour
```

---
Usage

If you have array of feature vectors `f`: `shape(shape)==(n_smpl, n_dim)`, you can create data tour object, and display it:

```
from datatour import DataTour as dt

ndv = dt(f)
ndv.display()
```
By default, selects randomly `n_subsample=500` samples for efficiency reason.

To visualize vector field `vf` of the same dimension (in the same feature space):

```
ndv = dt(f, vf)
ndv.display_quiver(color='z_scaled')
```

Also check examples:

```
dt().display()
```
![cube](https://raw.githubusercontent.com/neworldemancer/datatour_pkg/master/media/cube.png)


```
ndv = dt(example='sphere', n_subsample=0)
ndv.display(color='z_scaled')
```
![sphere](https://raw.githubusercontent.com/neworldemancer/datatour_pkg/master/media/sphere.png)

---
Licence
---

Distributed under BSD 3 licence

