Metadata-Version: 2.1
Name: EggLib
Version: 3.2.0a2
Summary: Evolutionary Genetics and Genomics Library
Home-page: https://egglib.org/
Author: Stéphane De Mita, Mathieu Siol
Author-email: demita@gmail.com
License: GPL v3
Download-URL: https://pypi.org/project/EggLib/3.2.0a2/#files
Project-URL: Bug Tracker, https://gitlab.com/demita/egglib/-/issues
Project-URL: Documentation, https://egglib.org/
Project-URL: Source Code, https://gitlab.com/demita/egglib/-/tree/master
Description: =====================================
        EggLib documentation!
        =====================================
        
        .. image:: ./doc/logo/banner.png
           :target: ./doc/logo/banner.png
           :alt: EggLib Logo
        
        |PythonVersions| |PypiPackage|
        
        .. contents:: Table of Contents
           :depth: 3
        
        
        About
        =====
        
        EggLib is a Python library, largely implemented in C++, for evolutionary
        genetics and genomics. Main features are sequence data management,
        sequence polymorphism analysis, and coalescent simulations. EggLib is a
        flexible Python module with a performant underlying C++ library and
        allows fast and intuitive development of Python programs and scripts.
        
        **EggLib home page:** `<https://www.egglib.org>`_
        
        
        Installation
        ============
        
        EggLib is available on pip. For more information on installing EggLib or
        downloading source code please refer to the installation section of the
        documentation: `<https://egglib.org/install.html>`_.
        
        Cloning
        =======
        
        You can clone the whole package using::
        
            git clone https://gitlab.com/demita/egglib.git
        
        For example, this lets you access to the current version on development::
        
            cd egglib
            git checkout dev
        
        Building local documentation
        ============================
        
        To generate the documentation locally, you should clone the repository,
        and run this (assuming the package has been installed)::
        
            python setup.py build_sphinx
            python setup.py build_pdf
        
        The first command generates the html documentation (available in the
        ``doc/build/html`` directory) and the second generates three pdf
        documents containing the main sections of the documentation (in the
        ``doc/build/latex`` directory).
        
        To generate documentation, one needs:
        
        * A LaTex processor, containing the following packages: anyfontsize,
          amsmath, fncychap, capt-of, needspace, framed, upquote, wrapfig (and
          possibly others).
        * ``python3-sphinx``
        * ``python3-svgwrite``
        * ``latexmk``
        
        Citation
        ========
        
        De Mita S. and M. Siol. 2012. EggLib: processing, analysis and simulation tools for population genetics and genomics. *BMC Genet.* **13**:27.
        `Open access <http://www.biomedcentral.com/1471-2156/13/27/abstract>`_
        
        License
        =======
        
        EggLib is free software: you can redistribute it and/or modify it under
        the terms of the GNU General Public License as published by the Free
        Software Foundation, either version 3 of the License, or (at your
        option) any later version.
        
        EggLib is distributed in the hope that it will be useful, but WITHOUT
        ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
        FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
        for more details.
        
        `<https://www.egglib.org/licence.html>`_
        
        .. |PythonVersions| image:: https://img.shields.io/badge/python-3.6+-blue.svg
           :target: https://www.python.org/downloads
           :alt: Python 3.6+
        
        .. |PypiPackage| image:: https://badge.fury.io/py/EggLib.svg
           :target: https://pypi.org/project/EggLib
           :alt: PyPi package
        
Platform: platform-independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/x-rst
Provides-Extra: doc
