.. DISMaL documentation master file, created by
   sphinx-quickstart on Thu May  2 14:24:15 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to DISMaL's documentation!
==================================

``DISMaL`` is a Python package for inferring historical demographies
(specifically, population sizes, gene flow, and split times) from
sequence data. It is an implementation of the *Generalised
isolation-with-migration* (GIM) model of Costa & Wilkinson-Herbots
(2021). Please cite their paper if you use ``DISMaL`` in published work:

*Rui J. Costa, Hilde M. Wilkinson-Herbots (2021). Inference of gene flow
in the process of speciation: Efficient maximum-likelihood
implementation of a generalised isolation-with-migration model.
Theoretical Population Biology 140:1-15.
https://doi.org/10.1016/j.tpb.2021.03.001.*

**This package and its documentation is still a work in progress. Please inform us of any bugs or omissions by raising an issue on GitHub**

Installation
------------

DISMaL is currently only available as a pre-release from GitHub. Install using:

::

   pip install git+https://github.com/simonharnqvist/DISMaL.git#egg=dismal


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   api



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`