Metadata-Version: 2.4
Name: cr_trichome
Version: 0.1.1
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
License-File: LICENSE
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

<div align="center" style="width: min(100%, 600px);">
    <picture>
        <source
            media="(prefers-color-scheme: dark)"
            srcset="docs/source/_static/cr_trichome_dark_mode.svg"
            width=100%
        >
        <source
            media="(prefers-color-scheme: light)"
            srcset="docs/source_static/cr_trichome.svg"
            width=100%
        >
        <img alt="The cellular_raza logo" src="doc/cellular_raza.svg">
    </picture>
</div>

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/jonaspleyer/cr_trichome/CI.yml?style=flat-square&label=Build)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/jonaspleyer/cr_trichome/sphinx_doc.yml?style=flat-square&label=Docs)
![PyPI - Version](https://img.shields.io/pypi/v/cr_trichome?style=flat-square&label=PyPi)

Package to model trichome growth on the leaf of arabidopsis thaliana.

# Documentation
Visit the documentation at [jonaspleyer.github.io/cr_trichome/](https://jonaspleyer.github.io/cr_trichome/).
We use `cellular_raza` as the underlying simulation framework.
Its documentation can be seen at [cellular_raza.com](https://cellular_raza.com).

# Usage
To build the package run
```bash
maturin develop
```

Afterwards, the package can be used like so:
```python
import cr_trichome as crt
```

# Testing
To run tests for the rust part of the package use

```bash
cargo test
```

To run python tests, we use pytest

```bash
python -m pytest
```

