Metadata-Version: 2.1
Name: actinrings
Version: 1.1.0
Summary: Python package for the equilibrium analysis of the paper "Constriction of actin rings by passive crosslinker".
Home-page: https://github.com/cumberworth/actinrings
Author: Alexander Cumberworth
Author-email: alex@cumberworth.org
Project-URL: Paper, https://doi.org/10.48550/arXiv.2203.04260
Project-URL: Replication package for paper, https://doi.org/10.5281/zenodo.6327217
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Supporting python modules for equilibrium analysis in "Constriction of actin rings by passive crosslinkers"

[![DOI](https://zenodo.org/badge/420147949.svg)](https://zenodo.org/badge/latestdoi/420147949)

Python package for the equilibrium analysis of [Ref. 1](#references).

It includes a module implementing the equilibrium model, as well as a module for creating plots with this model, as well as plots from finite element calculations output from a related package ([elastic-rings](https://github.com/cumberworth/elastic-rings)) and plots from Monte Carlo simulations from another related package ([ActinRingsMC.jl](https://github.com/cumberworth/ActinRingsMC.jl)).

Some example scripts for creating plots are provided in the [`scripts`](scripts/) directory.

## Installation

This package was developed and used on Linux.
[It is available on the PyPI respository](https://pypi.org/project/actinrings/).
It can be installed by running
```
pip install actinrings
```
If you are not using a virtual environment, the `--user` flag may be used instead to install it locally to the user.
To install directly from this repository, run
```
python -m build
pip install dist/actinrings-[current version]-py3-none-any.whl
```
To run the above, it may be necessary to update a few packages:
```
python3 -m pip install --upgrade pip setuptools wheel
```

For more information on building and installing python packages, see the documentation from the [Python Packaging Authority](https://packaging.python.org/en/latest/).

## References

[1] A. Cumberworth and P. R. ten Wolde, Constriction of actin rings by passive crosslinkers, [arXiv:2203.04260 [physics.bio-ph]](https://doi.org/10.48550/arXiv.2203.04260).

## Links

[Python Packaging Authority](https://packaging.python.org/en/latest/)

[elastic-rings](https://github.com/cumberworth/elastic-rings)

[ActinRingsMC.jl](https://github.com/cumberworth/ActinRingsMC.jl)

[Replication package Ref. 1](https://doi.org/10.5281/zenodo.6327217)
