Skip to content

Commit

Permalink
Installation instruction to pip
Browse files Browse the repository at this point in the history
  • Loading branch information
benfulcher committed Jul 6, 2022
1 parent 680ca1c commit 8610d18
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,6 @@ For details about the features, see the [main _catch22_ repository](https://gith

## Installation

### Manual

Using `setuptools`:

```
python3 setup.py build
python3 setup.py install
```

### `pip`

Using `pip` for [`pycatch22`](https://pypi.org/project/pycatch22/):

```
Expand Down Expand Up @@ -55,9 +44,18 @@ Usage:
pycatch22.catch22_all(tsData)
```

## Usage notes
### Usage notes

- When presenting results using _catch22_, you must identify the version used to allow clear reproduction of your results. For example, `CO_f1ecac` was altered from an integer-valued output to a linearly interpolated real-valued output from v0.3.
- __Important Note:__ _catch22_ features only evaluate _dynamical_ properties of time series and do not respond to basic differences in the location (e.g., mean) or spread (e.g., variance).
- From _catch22_ v0.3, If the location and spread of the raw time-series distribution may be important for your application, we suggest applying the function argument `catch24 = True` to your call to the _catch22_ function in the language of your choice.
This will result in 24 features being calculated: the _catch22_ features in addition to mean and standard deviation.

### Manual install

If you find issues with the `pip` install, you can also install using `setuptools`:

```
python3 setup.py build
python3 setup.py install
```

0 comments on commit 8610d18

Please sign in to comment.