Metadata-Version: 2.4
Name: tstrait
Version: 0.1.2
Summary: Quantitative trait simulation of tree sequence data
Author: Daiki Tagami et al.
Maintainer-email: Tskit Developers <admin@tskit.dev>
License: MIT
Project-URL: Homepage, https://tskit.dev/tstrait/
Project-URL: Bug Tracker, https://github.com/tskit-dev/tstrait/issues
Project-URL: Documentation, https://tskit.dev/tstrait/docs/
Project-URL: Source Code, https://github.com/tskit-dev/tstrait
Keywords: gwas,population genetics,quantitative trait,simulation,statistical genetics,tree sequence,tskit
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2
Requires-Dist: numba
Requires-Dist: pandas>=1.0
Requires-Dist: tskit>=1
Dynamic: license-file

# tstrait

[![License](https://img.shields.io/github/license/tskit-dev/tstrait)](https://github.com/tskit-dev/tstrait/blob/main/LICENSE) [![PyPI version](https://img.shields.io/pypi/v/tstrait.svg)](https://pypi.org/project/tstrait/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/tstrait.svg)](https://pypi.org/project/tstrait/) [![Docs Build](https://github.com/tskit-dev/tstrait/actions/workflows/docs.yml/badge.svg)](https://github.com/tskit-dev/tstrait/actions/workflows/docs.yml) [![Tests](https://github.com/tskit-dev/tstrait/actions/workflows/tests.yml/badge.svg)](https://github.com/tskit-dev/tstrait/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/tskit-dev/tstrait/branch/main/graph/badge.svg)](https://codecov.io/gh/tskit-dev/tstrait)

**tstrait** is a quantitative trait simulator of [tskit](https://tskit.dev) tree sequences. It supports simulation of quantitative traits, sampling genetic effect sizes from various distributions, modelling pleiotropic phenotypes and environmental noise, and computing per‑individual genetic values given the effect sizes of causal mutations.

Documentation: https://tskit.dev/tstrait/docs/stable/ (latest: https://tskit.dev/tstrait/docs/latest/)
Learn more about tree sequences: https://tskit.dev/learn/

## Installation

```bash
python -m pip install tstrait
# or
conda install -c conda-forge tstrait
```

## Quickstart

See the documentation quickstart and examples: https://tskit.dev/tstrait/docs/stable/
