Skip to content

Commit

Permalink
list features of ewstools
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasMBury committed Dec 12, 2022
1 parent 6c6e684 commit 45c3258
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,22 +37,17 @@ Now, there exist a multitude of different EWS and associated methods for
anticipating bifurcations [@clements2018indicators].


The goal of `ewstools` is to provide an accessible toolbox for computing, analysing and
visualising EWS in Python.


`ewstools` is a Python package to compute, analyse and visualise early warning signals in time series data.
The package provides:

- Python API and a command-line interface for wide accessibility
- Automatic dataset splitting and cross-validation
- Five models from various back-ends in a unified interface that cover a broad range of common use cases
- Solutions for very large datasets and heteroskedastic data
- Integrated plotting and evaluation functions to quickly check the validity of the model fit and results
`ewstools` provides an accessible toolbox for computing, analysing and
visualising EWS in time seires data. The package provides:

- Time series detrending methods
- A suite of standard statistical metrics that can provide an EWS (e.g. variance, autocorrelation, skew)
- A suite of spectral EWS, which are based on the power spectrum [@bury2020detecting]
- Methods to apply deep learning classifiers for EWS [@bury2021deep]
- Integrated plotting and evaluation functions to quickly check the performance of EWS
- Comprehensive and interactive tutorials



Earlier versions of `ewstools` were used in the following publications:
- @bury2020detecting
- @bury2021deep
Expand All @@ -77,11 +72,6 @@ results [@bury2021deep]



# Statement of need




`ewstools` makes use of several open-source Python packages, including
pandas [@mckinney2010data] for dataframe handling,
numpy [@harris2020array] for fast numerical computing,
Expand All @@ -93,6 +83,12 @@ and TensorFlow [@abadi2016tensorflow] for deep learning.





# Statement of need



# Usage Example

```python
Expand Down Expand Up @@ -120,7 +116,7 @@ ts.compute_ktau()
fig = ts.make_plotly()
```

![Output of code in usage example.\label{fig:Figure 1}](figure1.png)
![Output of plotting function in usage example.\label{fig:Figure 1}](figure1.png)


# Documentation
Expand Down

0 comments on commit 45c3258

Please sign in to comment.