Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbriegal authored Jan 20, 2018
1 parent d4c18e2 commit 220b27f
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,28 @@

## Installation
Only requirement for installation is CMAKE (https://cmake.org).
From above top level run 'pip install ./GACF'

From above top level run
```
pip install ./GACF
```
in python:

```python
from GACF import *

correlation_dictionary = find_correlation_from_file('filepath')
```
OR
```python
correlation_dictionary = find_correlation_from_lists(values, timeseries, errors=None)

```
with options:

```python
max_lag=None, lag_resolution=None, selection_function='natural', weight_function='gaussian', alpha=None

```
### Examples

function_import_sine_wave_test.py creates a randomly sampled sine wave and finds the autocorrelation
using the created functions when importing GACF

objects_test_from_file.py exposes the underlying c++ object structure to find the correlation of a timeseries from file
objects_test_from_file.py exposes the underlying c++ object structure to find the correlation of a timeseries from file

0 comments on commit 220b27f

Please sign in to comment.