Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tanukihee committed Apr 17, 2024
1 parent 341e824 commit 93cacaa
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,34 @@ Notice: This package is the brand new version of the old `Pearson3CurveFitting`
package. For the old version, please refer to the
[archived repository](https://github.com/tanukihee/Pearson3CurveFittingArchive).

## Installation

```bash
pip install pearson3curve
```

## Usages

See [API Documentation](https://github.com/tanukihee/pearson3curve/blob/main/docs/api.md) for details.

## Examples

### Successive Data

See [Successive Data Example](./example/successive.py) for the code.
See [Successive Data Example](https://github.com/tanukihee/pearson3curve/blob/main/example/successive.py) for the code.

Figure example:

<img src="./example/successive.png" width="100%" alt="successive"/>
<img src="https://raw.githubusercontent.com/tanukihee/pearson3curve/main/example/successive.png" width="100%" alt="successive"/>

### Non-Successive Data

See [Non-Successive Data Example](./example/nonsuccessive.py) for the code.
See [Non-Successive Data Example](https://github.com/tanukihee/pearson3curve/blob/main/example/nonsuccessive.py) for the code.

Figure example in Chinese, using pgf backend for better multi-language text and
math typesetting support:

<img src="./example/nonsuccessive.svg" width="100%" alt="nonsuccessive"/>

## Usages

See [API Documentation](./docs/api.md) for details.
<img src="https://raw.githubusercontent.com/tanukihee/pearson3curve/main/example/nonsuccessive.svg" width="100%" alt="nonsuccessive"/>

## Development

Expand Down
8 changes: 7 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "pearson3curve"
version = "1.0.0"
version = "1.0.0r"
description = "Pearson III curve fitting and plotting"
authors = [{ name = "ListLee", email = "[email protected]" }]
dependencies = [
Expand All @@ -13,6 +13,12 @@ requires-python = ">=3.9"
readme = "README.md"
license = { text = "MIT" }

[project.urls]
Homepage = "https://github.com/tanukihee/pearson3curve"
Documentation = "https://github.com/tanukihee/pearson3curve/blob/main/docs/api.md"
Repository = "https://github.com/tanukihee/pearson3curve.git"
Issues = "https://github.com/tanukihee/pearson3curve/issues"

[build-system]
requires = ["pdm-backend"]
build-backend = "pdm.backend"
Expand Down

0 comments on commit 93cacaa

Please sign in to comment.