Metadata-Version: 2.1
Name: pyperspairdiamorse
Version: 0.0.5
Summary: Cross-platform C++ library of persistent pair extractor using the diamorse approach
Author: Andrey S. Zubov, Kirill M. Gerke, Andrey A. Ananev
Author-email: zubov.as@mipt.ru
License: GPLv3
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy

# PyPersPairDiaMorse

TODO

Authors: TODO

## Prerequisites

### Install a modern C++ compiler

Mac OS:

```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" && xcode-select --install
```

Linux (Ubuntu):

```
sudo apt-get install g++
```

Windows: Visual Studio 2015 or later with C++ tools installed

### Install PyPersPairDiaMorse

The easiest way to install and run **PyPersPairDiaMorse** is to utilize Python virtual environments (below are the commands to setup **PyPersPairDiaMorse** in Unix-based operation system, similar approach can be applied under Windows):

1. Here env_name is any environment name that will used to run **PyPersPairDiaMorse**. `path_to_env` - path to the environment where it will be created (Use '.') if it's current folder.

```
python -m venv path_to_env/env_name
source path_to_env/env_name/bin/activate
```

2. After, you need to install package `pip install pyperspairdiamorse`.

3. Example usage:

```
import numpy as np
import pyperspairdiamorse

TODO
```
