diff --git a/README.md b/README.md index b6863fc..f140269 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,33 @@ The code is licensed under the [GNU GPL v3 license](http://www.gnu.org/licenses/ **Feel free to reach out for help with real-world applications.** Feedback is much appreciated through [issues](https://github.com/DynamicsAndNeuralSystems/pyspi/issues), or [pull requests](https://github.com/DynamicsAndNeuralSystems/pyspi/pulls). -## Acknowledgement +## Acknowledgement :+1: -If you use this code, please cite the following preprint: +If you use this software, please read and cite this article: -Oliver M. Cliff, Annie G. Bryant, Joseph T. Lizier, Naotsugu Tsuchiya, Ben D. Fulcher, "Unifying Pairwise Interactions in Complex Dynamics," _arXiv_ preprint, [arXiv:2201.11941](https://arxiv.org/abs/2201.11941) (2023). +- 📗 O.M. Cliff, A.G. Bryant, J.T. Lizier, N. Tsuchiya, B.D. Fulcher [Unifying pairwise interactions in complex dynamics](https://doi.org/10.1038/s43588-023-00519-x), _Nature Computational Science_ (2023). + +Note that [preprint](https://arxiv.org/abs/2201.11941) and [free-to-read](https://rdcu.be/dn3JB) versions of this article are available. ## Getting Started See the [documentation](https://pyspi-toolkit.readthedocs.io/en/latest/) for installing and setting up _pyspi_. Once you're done, you can learn how to use the package by checking out the: -- [Simple demo](https://github.com/olivercliff/pyspi/blob/main/demos/simple_demo.py) -- [Tutorial (finance: stock price time series)](https://github.com/olivercliff/pyspi/blob/main/demos/tutorial.ipynb) +- [Simple demo](https://github.com/DynamicsAndNeuralSystems/pyspi/blob/main/demos/simple_demo.py) +- [Tutorial (finance: stock price time series)](https://github.com/DynamicsAndNeuralSystems/pyspi/blob/main/demos/tutorial.ipynb) - [Tutorial (neuroimaging: fMRI time series)](https://github.com/anniegbryant/CNS_2022/blob/main/pyspi_tutorial/CNS2022_pyspi_demo.ipynb). If you have access to a PBS cluster and are processing MTS with many processes (or are analyzing many MTS), then you may find the [_pyspi_ distribute](https://github.com/DynamicsAndNeuralSystems/pyspi-distribute) repository helpful. -If your dataset is large (containing many processes and/or observations), you can use a pre-configured set of reduced statistics or create your own subsets (cf. the [documentation guide](https://pyspi-toolkit.readthedocs.io/en/latest/advanced.html#using-a-reduced-spi-set)). +If your dataset is large (containing many processes and/or observations), you may wish to start with a pre-configured set of reduced statistics or create your own subsets (cf. the [documentation guide](https://pyspi-toolkit.readthedocs.io/en/latest/advanced.html#using-a-reduced-spi-set)). + +### Distributed computation on a high-performance computing (HPC) cluster + +Alternatively, _pyspi_ can be configured to distribute individual jobs across an HPC cluster using the [pyspi-distribute](https://github.com/DynamicsAndNeuralSystems/pyspi-distribute) repository. +We provide some [benchmark estimates](https://pyspi-toolkit.readthedocs.io/en/latest/faq.html#how-long-does-pyspi-take-to-run) for how long a given MTS dataset will take to compute across a variety of parameters for HPC resource request purposes. +For more information about this functionality, check out the [repository readme](https://github.com/DynamicsAndNeuralSystems/pyspi-distribute#distribute-pyspi-jobs-across-a-pbs-cluster) and the [_pyspi_ documentation](https://pyspi-toolkit.readthedocs.io/en/latest/index.html). + ## Other highly comparative toolboxes @@ -43,4 +52,4 @@ If your dataset is large (containing many processes and/or observations), you ca ## SPI Wishlist -As _pyspi_ is under active development, we are always open to suggestions for new SPIs to be added via the [projects tab](https://github.com/DynamicsAndNeuralSystems/pyspi/projects) in this repo. +As _pyspi_ is under active development, we are always open to suggestions for new SPIs to be added via the [projects tab](https://github.com/DynamicsAndNeuralSystems/pyspi/projects) in this repo. diff --git a/docs/source/_build/html/usage.html b/docs/source/_build/html/usage.html index 00d406b..abe8ee5 100644 --- a/docs/source/_build/html/usage.html +++ b/docs/source/_build/html/usage.html @@ -10,7 +10,7 @@ - + @@ -19,10 +19,10 @@ - + -
+