Skip to content

Commit

Permalink
Updated version numbers in the README and added a new What's new in s…
Browse files Browse the repository at this point in the history
…ection. Added a couple more items to the CHANGELOG.
  • Loading branch information
blakeaw committed Jul 1, 2024
1 parent ee55df4 commit 16bd3ea
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,21 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [0.3.0] - 2024-06-28
## [0.3.0] - 2024-07-01

### Added

- New PD macro `fixed_effect` encoding a fixed-effect model for the effect/response. Issue https://github.com/blakeaw/pysb-pkpd/issues/7
- `intercept` argument for the `linear_effect` PD model which allows users to set the y-intercept of the linear model. Issue https://github.com/blakeaw/pysb-pkpd/issues/9
- New PD macro `loglinear_effect` encoding a log-linear model for the effect/response as a function of concentration. Issue https://github.com/blakeaw/pysb-pkpd/issues/8
- New `util` module that defines the `simulate` function: Issue https://github.com/blakeaw/pysb-pkpd/issues/11

### Changed

- Replaced the `setup.py` script with a `pyproject.toml`; Issue https://github.com/blakeaw/pysb-pkpd/issues/13
- `linear_effect` PD macro: updated the parameter names to prefix them with `LinEffect_` to make sure they are unique.


## [0.2.1] - 2023-10-17

### Fixed
Expand Down
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,23 @@
![Python version badge](https://img.shields.io/badge/python-3.11.3-blue.svg)
[![PySB version badge](https://img.shields.io/badge/PySB->%3D1.15.0-9cf.svg)](https://pysb.org/)
[![license](https://img.shields.io/github/license/blakeaw/pysb-pkpd.svg)](LICENSE)
![version](https://img.shields.io/badge/version-0.2.1-orange.svg)
[![release](https://img.shields.io/github/release-pre/blakeaw/pysb-pkpd.svg)](https://github.com/blakeaw/pysb-pkpd/releases/tag/v0.2.1)
![version](https://img.shields.io/badge/version-0.3.0-orange.svg)
[![release](https://img.shields.io/github/release-pre/blakeaw/pysb-pkpd.svg)](https://github.com/blakeaw/pysb-pkpd/releases/tag/v0.3.0)


__`pysb-pkpd` enables you to efficiently program and simulate dynamic PK/PD and QSP models in Python using the PySB modeling framework.__

:pill: :computer:

## What's new in

**version 0.3.0**

* Macro encoding a Fixed-effect PD model: `fixed_effect`
* Macro encoding a Log-linear Effect PD model: `loglinear_effect`
* `simulate` function to simplify the process of simulating models.
* The macro encoding the Linear-effect PD model, `linear_effect`, has an optional `intercept` argument to allow users to set the y-intercept of the linear model.

## Table of Contents

1. [Install](#install)
Expand Down Expand Up @@ -47,27 +56,27 @@ Note that `pysb-pkpd` has the following core dependencies:

### pip install

You can install `pysb-pkpd` version 0.2.1 with `pip` sourced from the GitHub repo:
You can install `pysb-pkpd` version 0.3.0 with `pip` sourced from the GitHub repo:

##### with git installed:

Fresh install:
```
pip install git+https://github.com/blakeaw/pysb-pkpd@v0.2.1
pip install git+https://github.com/blakeaw/pysb-pkpd@v0.3.0
```
Or to upgrade from an older version:
```
pip install --upgrade git+https://github.com/blakeaw/pysb-pkpd@v0.2.1
pip install --upgrade git+https://github.com/blakeaw/pysb-pkpd@v0.3.0
```
##### without git installed:

Fresh install:
```
pip install https://github.com/blakeaw/pysb-pkpd/archive/refs/tags/v0.2.1.zip
pip install https://github.com/blakeaw/pysb-pkpd/archive/refs/tags/v0.3.0.zip
```
Or to upgrade from an older version:
```
pip install --upgrade https://github.com/blakeaw/pysb-pkpd/archive/refs/tags/v0.2.1.zip
pip install --upgrade https://github.com/blakeaw/pysb-pkpd/archive/refs/tags/v0.3.0.zip
```
### Manual install

Expand Down

0 comments on commit 16bd3ea

Please sign in to comment.