Skip to content

Commit

Permalink
update: README
Browse files Browse the repository at this point in the history
  • Loading branch information
huangziwei committed Nov 26, 2024
1 parent 4bb9c1b commit 4e5da12
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,38 @@

# PyCircStat2: Circular statistics with Python

A rework of [pycircstat](https://github.com/circstat/pycircstat).
A rework of [pycircstat](https://github.com/circstat/pycircstat).

[**Installlation**](#installation) |
[**Installlation**](#installation) |
[**Examples**](#examples) (
[**Books**](#books) |
[**Topics**](#topics)
[**Books**](#books) |
[**Topics**](#topics)
)

## Installation

```
pip install pycircstat2
```

To install the development version, clone the repository and install it with `pip -e`:

```
git clone https://github.com/circstat/pycircstat2
pip install -e pycircstat2
pip install -e pycircstat2
```

## Examples

### Books

- [Statistical Analysis of Circular Data](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/B1-Fisher-1993.ipynb) (Fisher, 1993)
- [Chapter 26 and 27](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/B2-Zar-2010.ipynb) from Biostatistical Analysis (Zar, 2010).
- [Circular Statistics in R](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/B3-Pewsey-2014.ipynb) (Pewsey, et al., 2014)
- [Statistical Analysis of Circular Data](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/B1-Fisher-1993.ipynb) (Fisher, 1993)
- [Chapter 26 and 27](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/B2-Zar-2010.ipynb) from Biostatistical Analysis (Zar, 2010).
- [Circular Statistics in R](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/B3-Pewsey-2014.ipynb) (Pewsey, et al., 2014)

### Topics

- [Utils](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T0-utils.ipynb)
- [Descriptive Statistics](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T1-descriptive-statistics.ipynb)
- [Hypothesis Testing](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T2-hypothesis-testing.ipynb)
- [Circular Models](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T3-circular-models.ipynb)
- [Utils](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T0-utils.ipynb)
- [Descriptive Statistics](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T1-descriptive-statistics.ipynb)
- [Hypothesis Testing](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T2-hypothesis-testing.ipynb)
- [Circular Models](https://nbviewer.org/github/circstat/pycircstat2/blob/main/examples/T3-circular-models.ipynb)

0 comments on commit 4e5da12

Please sign in to comment.