Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasMBury committed Mar 15, 2019
2 parents a4835f5 + a74cfd8 commit 30cf842
Showing 1 changed file with 5 additions and 26 deletions.
31 changes: 5 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,44 +18,23 @@ Functionality includes

- Visualisation of EWS with plots of time-series and power spectra.

Dependencies include
- numpy, pandas, seaborn
- lmfit, arch


## Install:

ewstools requires Python version 3.7 or later to be installed on your system. You can than install ewstools by entering
*ewstools* requires Python version 3.7 or later to be installed on your system. Then *ewstools* can be installed using pip, by entering the following into your command line.
```python
pip install ewstools
```
into the command line.

Installation with conda will be available soon, for those with an Anaconda distribution.


## Documentation

Full documentation is available [here](https://ewstools.readthedocs.io/en/latest/).


## Demos

iPython notebooks demonstrating how to use the software are available [here](examples/).

## Documentation

Full documentation for *ewstools* is available on [ReadTheDocs](https://ewstools.readthedocs.io/en/latest/).

## Quick walkthrough











## Contribution

If you are interested in being a contributer to *ewstools*, or run into trouble with the package, please post on the [issue tracker](https://github.com/ThomasMBury/ewstools/issues).

0 comments on commit 30cf842

Please sign in to comment.