Welcome to evofr’s documentation!

Overview

evofr is a Python package designed for evolutionary forecasting of genetic variants. This project provides tools aimed at modeling and predicting the evolution and prevalence of genetic variants over time. The package integrates various data handling, modeling, and plotting capabilities, making it a useful toolkit for researchers in the field of genetic epidemiology and evolutionary dynamics.

Installation

You can install the latest release of evofr directly using pip:

pip install evofr

For those looking to contribute or modify the package, it can be built locally with:

poetry build
pip install path-to-wheel>

Indices and tables

• Index

• Module Index

• Search Page

Contents

• Installation Guide
  • Installing with pip
  • Installing from Source
  • Installing from Source Using Poetry
  • Environment Setup
  • Additional Installation Help
• API Reference
  • evofr.data package
  • evofr.models package
  • evofr.infer package
  • evofr.posterior package
  • evofr.plotting package
• Getting started with evofr
  • Handling model results
  • Exporting as DataFrames
  • Plotting model results