Metadata-Version: 2.1
Name: copatrec
Version: 0.0.2
Summary: Correlation pattern recognizer (Copatrec), a package to find nonlinear patterns (regressions) using Machine Learning.
Author: Siamak Khatami
Author-email: <siamak.khatami@ntnu.no>
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: Free for non-commercial use
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE


Correlation pattern recognizer (Copatrec) package.

For more information, please see the example and Document notebook.



# How to use Copatrec

To use Copatrec, it should be either cloned from the GitHub, or

installed using the package files (pip and py providers will

be ready in future)



## Recommended installation

It is recommended to install copatrec using `pip` (see below).



## Installing using pip

To install copatrec, please use the following code in your terminal:



```pip install copatrec```



## Cloning (copying) source code:

The source code is organised in a hierarchical structure to ease the creation of package files. 

Following convention, the source code can be found in 'src' folder, and  examples can be found in 'example' folder.



### Required packages to use Copatrec

If the package is installed from GitHub, then it would be suggested

to install following packages (dependencies) in your system using `pip` or any other 

preferred approaches. 

- matplotlib

- numpy

- pandas

- scipy

- sklearn



# Examples



The examples folder can be found under in the GitHub repo. Its direct URL is:



https://github.com/copatrec/copatrec/tree/master/examples



## JSS.py

An example file with setups to reproducing paper results for the Journal of Statistical Software.



## Tutorial files

There are two files in different formats (.py and .ipynb). For a detailed tutorial of Copatrec, the Jupyter

file (Document.ipynb) is recommended. 

