# PolyKin
[![Test](https://github.com/HugoMVale/polykin/actions/workflows/test.yml/badge.svg)](https://github.com/HugoMVale/polykin/actions)
[![codecov](https://codecov.io/gh/HugoMVale/polykin/branch/main/graph/badge.svg?token=QfqQLX2rHx)](https://codecov.io/gh/HugoMVale/polykin)
[![Latest Commit](https://img.shields.io/github/last-commit/HugoMVale/polykin)](https://img.shields.io/github/last-commit/HugoMVale/polykin)
PolyKin is an open-source polymerization kinetics library for Python. It is still at an early
development stage, but the following modules can already be used:
- Activity coefficient models
- [x] Ideal solution
- [x] Flory-Huggins
- [x] NRTL
- [ ] Poly-NRTL
- [x] UNIQUAC
- [x] Wilson
- Copolymerization
- [x] Implicit penultimate model
- [x] Penultimate model
- [x] Terminal model
- [x] Mayo-Lewis equation (binary, ternary and multicomponent)
- [x] Monomer drift equation (binary and multicomponent)
- [ ] Fitting methods
- Equations of state
- [50%] Cubic (Redlich-Kwong, Soave, Peng-Robinson)
- [x] Ideal gas
- [ ] Sanchez-Lacombe
- [x] Virial equation
- [ ] Database
- Distributions
- [x] Flory
- [ ] Gold
- [x] Log-normal
- [x] Poison
- [x] Schulz-Zimm
- Kinetics
- [x] Arrhenius
- [x] Eyring
- [x] Propagation half-length
- [x] Termination composite model
- Math
- [x] Joint confidence regions
- [ ] Models
- Physical property correlations
- [x] Antoine
- [x] DIPPR
- [x] Wagner
- [x] Yaws
- Step-growth polymerization
- [x] Analytical solutions for $M_n$ and $M_w$
- Transport properties (estimation methods, mixing rules, etc.)
- Diffusivity
- [x] Binary gas mixtures
- [x] Binary liquid mixtures
- [x] Binary polymer solutions
- [ ] Multicomponent polymer solutions
- Thermal conductivity
- [x] Gases
- [x] Liquids
- [ ] Polymer solutions
- Viscosity
- [x] Gases
- [x] Liquids
- [ ] Polymer solutions
## Documentation
Please refer to the package [homepage](https://hugomvale.github.io/polykin/).
## Tutorials
The main features of PolyKin are explained and illustrated through a series of [tutorials](https://hugomvale.github.io/polykin/tutorials/) based on Jupyter [notebooks](https://github.com/HugoMVale/polykin/tree/main/docs/tutorials),
which can be launched online via Binder.
<p align="center">
<a href="https://github.com/HugoMVale/polykin">
<img src="https://raw.githubusercontent.com/HugoMVale/polykin/8e54e0b492b4dd782c2fe92b52f617dda71a29b3/docs/deconvolution.svg" width=600 alt="MWD of a polymer blend">
</a>
</p>
## Installation
PolyKin currently runs on Python 3.9+. You can install it from PyPI via `pip` (or `poetry`):
```console
pip install polykin
# poetry add polykin
```
Alternatively, you may install it directly from the source code repository:
```console
git clone https://github.com/HugoMVale/polykin.git
cd polykin
pip install .
# poetry install
```
Raw data
{
"_id": null,
"home_page": "https://hugomvale.github.io/polykin/",
"name": "polykin",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "polymer, polymerization, kinetics, reaction",
"author": "HugoMVale",
"author_email": "57530119+HugoMVale@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/57/cf/ee1b1ceb7aa2ef03676316857a950950f5d1a7d6c5bb44a7562dc038606f/polykin-0.5.4.tar.gz",
"platform": null,
"description": "# PolyKin\n\n[![Test](https://github.com/HugoMVale/polykin/actions/workflows/test.yml/badge.svg)](https://github.com/HugoMVale/polykin/actions)\n[![codecov](https://codecov.io/gh/HugoMVale/polykin/branch/main/graph/badge.svg?token=QfqQLX2rHx)](https://codecov.io/gh/HugoMVale/polykin)\n[![Latest Commit](https://img.shields.io/github/last-commit/HugoMVale/polykin)](https://img.shields.io/github/last-commit/HugoMVale/polykin)\n\nPolyKin is an open-source polymerization kinetics library for Python. It is still at an early\ndevelopment stage, but the following modules can already be used:\n\n- Activity coefficient models\n - [x] Ideal solution\n - [x] Flory-Huggins\n - [x] NRTL\n - [ ] Poly-NRTL\n - [x] UNIQUAC\n - [x] Wilson\n- Copolymerization\n - [x] Implicit penultimate model\n - [x] Penultimate model\n - [x] Terminal model\n - [x] Mayo-Lewis equation (binary, ternary and multicomponent)\n - [x] Monomer drift equation (binary and multicomponent)\n - [ ] Fitting methods\n- Equations of state\n - [50%] Cubic (Redlich-Kwong, Soave, Peng-Robinson)\n - [x] Ideal gas\n - [ ] Sanchez-Lacombe\n - [x] Virial equation\n- [ ] Database\n- Distributions\n - [x] Flory\n - [ ] Gold\n - [x] Log-normal\n - [x] Poison\n - [x] Schulz-Zimm\n- Kinetics\n - [x] Arrhenius\n - [x] Eyring\n - [x] Propagation half-length\n - [x] Termination composite model\n- Math\n - [x] Joint confidence regions\n- [ ] Models\n- Physical property correlations\n - [x] Antoine\n - [x] DIPPR\n - [x] Wagner\n - [x] Yaws\n- Step-growth polymerization\n - [x] Analytical solutions for $M_n$ and $M_w$\n- Transport properties (estimation methods, mixing rules, etc.)\n - Diffusivity\n - [x] Binary gas mixtures\n - [x] Binary liquid mixtures\n - [x] Binary polymer solutions\n - [ ] Multicomponent polymer solutions \n - Thermal conductivity\n - [x] Gases\n - [x] Liquids\n - [ ] Polymer solutions\n - Viscosity\n - [x] Gases\n - [x] Liquids\n - [ ] Polymer solutions\n\n## Documentation\n\nPlease refer to the package [homepage](https://hugomvale.github.io/polykin/).\n\n## Tutorials\n\nThe main features of PolyKin are explained and illustrated through a series of [tutorials](https://hugomvale.github.io/polykin/tutorials/) based on Jupyter [notebooks](https://github.com/HugoMVale/polykin/tree/main/docs/tutorials),\nwhich can be launched online via Binder.\n\n<p align=\"center\">\n <a href=\"https://github.com/HugoMVale/polykin\">\n <img src=\"https://raw.githubusercontent.com/HugoMVale/polykin/8e54e0b492b4dd782c2fe92b52f617dda71a29b3/docs/deconvolution.svg\" width=600 alt=\"MWD of a polymer blend\">\n </a>\n</p>\n\n## Installation\n\nPolyKin currently runs on Python 3.9+. You can install it from PyPI via `pip` (or `poetry`):\n\n```console\npip install polykin\n# poetry add polykin\n```\n\nAlternatively, you may install it directly from the source code repository:\n\n```console\ngit clone https://github.com/HugoMVale/polykin.git\ncd polykin\npip install . \n# poetry install\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A polymerization kinetics library.",
"version": "0.5.4",
"project_urls": {
"Documentation": "https://hugomvale.github.io/polykin/",
"Homepage": "https://hugomvale.github.io/polykin/",
"Repository": "https://github.com/HugoMVale/polykin"
},
"split_keywords": [
"polymer",
" polymerization",
" kinetics",
" reaction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8dc92e59cbd871dfd560d9214db8567072e6531e16f501b88db556f0bf681391",
"md5": "1f7f8bb5731375d6fec4e28335cb963d",
"sha256": "ac0fb855de6b85e2fc46168882cd2b6c53cd25ff5b6d325113bfbb3331a34c5a"
},
"downloads": -1,
"filename": "polykin-0.5.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f7f8bb5731375d6fec4e28335cb963d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 144969,
"upload_time": "2024-04-22T20:38:58",
"upload_time_iso_8601": "2024-04-22T20:38:58.281079Z",
"url": "https://files.pythonhosted.org/packages/8d/c9/2e59cbd871dfd560d9214db8567072e6531e16f501b88db556f0bf681391/polykin-0.5.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57cfee1b1ceb7aa2ef03676316857a950950f5d1a7d6c5bb44a7562dc038606f",
"md5": "77934b08d6a61690bee05c5a906526e1",
"sha256": "c929925577e13f128b4d022f622ed49f54df27bd4ad5bf0a47e95c29b47fd042"
},
"downloads": -1,
"filename": "polykin-0.5.4.tar.gz",
"has_sig": false,
"md5_digest": "77934b08d6a61690bee05c5a906526e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 104705,
"upload_time": "2024-04-22T20:38:59",
"upload_time_iso_8601": "2024-04-22T20:38:59.610725Z",
"url": "https://files.pythonhosted.org/packages/57/cf/ee1b1ceb7aa2ef03676316857a950950f5d1a7d6c5bb44a7562dc038606f/polykin-0.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 20:38:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "HugoMVale",
"github_project": "polykin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "polykin"
}