Skip to content

Commit ef478a8

Browse files
olivercliffolivercliff
committed
Initial commit
0 parents  commit ef478a8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+8955
-0
lines changed

‎.gitignore‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
pyspi.egg-info
2+
pyspi/__pycache__
3+
**/__pycache__/**
4+
build
5+
dist
6+
*.pkl
7+
*.log
8+
*.bkp
9+
.vscode
10+
octave-workspace

‎.gitmodules‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "pyspi/lib/tigramite"]
2+
path = pyspi/lib/tigramite
3+
url = https://github.com/jakobrunge/tigramite.git

‎CHANGES‎

Whitespace-only changes.

‎LICENSE.txt‎

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

‎MANIFEST.in‎

Whitespace-only changes.

‎README.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Python Library of Statistics for Pairwise Interactions (pyspi)
2+
3+
*pyspi* provides a comprehensive library for computing pairwise interactions from multivariate time-series data.
4+
5+
The code provides easy access to evaluating hundreds of methods for evaluating the relationship between pairs of time series, from simple statistics (like correlation and coherence) to advanced multi-step algorithms (like convergent cross mapping and transfer entropy).
6+
7+
# Pre-installation
8+
9+
The code requires GNU's [Octave](https://www.gnu.org/software/octave/index) by default. Install octave using your favourite package manager, e.g.,
10+
```
11+
apt-get install octave
12+
```
13+
for Ubuntu;
14+
```
15+
pacman -S octave
16+
```
17+
for Arch; and
18+
```
19+
brew install octave
20+
```
21+
22+
for MacOS.
23+
24+
# Installation
25+
26+
Download or clone the [latest version](https://github.com/olivercliff/pyspi) from GitHub, unpack and run (from the folder containing `pyspi` setup.py file):
27+
28+
```
29+
pip install .
30+
```
31+
32+
or
33+
34+
```
35+
pip install -e .
36+
```
37+
38+
for editable mode.
39+
40+
We recommend the [installation in a conda environment](#conda-install).
41+
42+
## Getting started
43+
44+
Check out the demo scripts in `demos/demo.py` and `demos/demo.ipynb`
45+
46+
# <a name="conda-install"></a>Conda installation
47+
48+
```
49+
git clone https://github.com/olivercliff/pyspi.git
50+
conda create -n pyspi python=3.9.0
51+
conda activate pyspi
52+
cd pyspi
53+
pip install .
54+
python demos/demo.py
55+
```

‎bld.bat‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"%PYTHON%" setup.py install
2+
if errorlevel 1 exit 1

‎build.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
$PYTHON setup.py install # Python command to install the script.

‎conda_build_config.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
numpy:
2+
- 1.19.2

‎demos/config.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.statistics.spectral:
2+
3+
debiased_squared_weighted_phase_lag_index:
4+
- fs: 1
5+
statistic: max

0 commit comments

Comments
 (0)