Skip to content

Commit

Permalink
Merge branch 'development' of github.com:ThomasMBury/ewstools into de…
Browse files Browse the repository at this point in the history
…velopment
  • Loading branch information
ThomasMBury committed May 19, 2024
2 parents e122b78 + 84ac1ed commit 66f6fb0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ jobs:
python -m pip install --upgrade pip
pip install flake8 pytest pytest-cov
pip --default-timeout=100 install -e .
pip --default-timeout=100 install "keras<3.0.0"
pip --default-timeout=100 install "tensorflow>=2.0.0,<2.12"
- name: Lint with flake8
run: |
Expand All @@ -41,4 +40,4 @@ jobs:
uses: codecov/codecov-action@v3
with:
files: ./coverage.xml
verbose: true # optional (default = false)
verbose: true # optional (default = false)
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Many systems in nature and society have the capacity to undergo critical transit

The package provides:

- An intuitive, object-oriented framework for working with EWS in a given time series
- An intuitive, object-oriented framework for computing EWS for a given time series
- Time series detrending methods using
- A Gaussian kernel
- LOWESS (Locally Weighted Scatterplot Smoothing)
Expand All @@ -25,13 +25,13 @@ The package provides:
- Autocorrelation (at specified lag times)
- Higher-order statistical moments (skewness, kurtosis)
- Power spectrum and associated metrics
- Various entropy measures
- Computation of Kendall tau values to quantify trends
- Application of deep learning classifiers for bifurcation prediction as in [Bury et al. 2021](https://www.pnas.org/doi/10.1073/pnas.2106140118).
- Block-bootstrapping of time-series to obtain confidence intervals on EWS estimates
- Visualisation tools to display output
- Built-in theoretical models to test EWS

`ewstools` makes use of [pandas](https://pandas.pydata.org/) for dataframe handling, [numpy](https://numpy.org/) for fast numerical computing, [plotly](https://plotly.com/graphing-libraries/) for visuliastion, [lmfit](https://lmfit.github.io/lmfit-py/) for least-squares minimisation, [arch](https://github.com/bashtage/arch) for bootstrapping methods, [statsmodels](https://www.statsmodels.org/stable/index.html) and [scipy](https://scipy.org/) for detrending methods, and [TensorFlow](https://www.tensorflow.org/install) for deep learning.
`ewstools` makes use of [pandas](https://pandas.pydata.org/) for dataframe handling, [numpy](https://numpy.org/) for fast numerical computing, [plotly](https://plotly.com/graphing-libraries/) for visuliastion, [lmfit](https://lmfit.github.io/lmfit-py/) for least-squares minimisation, [arch](https://github.com/bashtage/arch) for bootstrapping methods, [EntropyHub](https://www.entropyhub.xyz/index.html) for entropy computations, [statsmodels](https://www.statsmodels.org/stable/index.html) and [scipy](https://scipy.org/) for detrending methods, and [TensorFlow](https://www.tensorflow.org/install) for deep learning.


## Install
Expand All @@ -57,7 +57,7 @@ Package dependencies are
'statsmodels>=0.9.0',
'scipy>=1.0.1',
```
and should be installed automatically. To use the deep learning functionality, you will need to install [TensorFlow](https://www.tensorflow.org/install) v2.0.0 or later with [Keras](https://keras.io/2.16/api/) v2.
and should be installed automatically. To use the deep learning functionality, you will need to install [TensorFlow](https://www.tensorflow.org/install) with version later than 2.0 and earlier than 2.12.

To install the latest *development* version, use the command
```bash
Expand Down
6 changes: 3 additions & 3 deletions requirements_dev.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pip==22.1.2
pip==23.3
setuptools==65.5.1
twine==4.0.1
wheel==0.38.1
Expand All @@ -13,6 +13,6 @@ plotly==5.9.0
lmfit==1.0.3
statsmodels==0.13.2
scipy==1.8.1
tensorflow==2.9.3
deprecation==2.1.0
EntropyHub==2.0
EntropyHub==2.0
tensorflow==2.11.1

0 comments on commit 66f6fb0

Please sign in to comment.