Metadata-Version: 1.1
Name: msprime
Version: 0.1.1a2
Summary: A fast and accurate coalescent simulator.
Home-page: http://pypi.python.org/pypi/msprime
Author: Jerome Kelleher
Author-email: jerome.kelleher@well.ox.ac.uk
License: GNU LGPLv3+
Description: =======
        msprime
        =======
        
        Msprime is a reimplementation of Hudson's classical ms program for modern
        datasets. It is under heavy development at the moment, and the present
        code should be considered beta quality. Bugs may be present,
        and the API might change considerably. We provide an ms-compatible
        command line interface ``mspms``, which should be useful to fit into
        existing workflows. However, the Python API is the recommended way to
        use msprime to gain full advantage of its internal structures.
        
        Full documentation is forthcoming.
        
        *************
        Requirements
        *************
        
        Msprime requires Python 2.7+ (Python 3 versions are fully supported from
        3.1 onwards), the `GNU Scientific Library <http://www.gnu.org/software/gsl/>`_
        and `HDF5 <https://www.hdfgroup.org/HDF5/>`_,
        which are available for all major platforms. For example, to install on
        Debian/Ubuntu use::
        
            # apt-get install python-dev libgsl0-dev libhdf5-serial-dev
        
        ----
        TODO
        ----
        
        - Need installation instructions for an RPM based distribution,
          HomeBrew/MacPorts and possibly a linux distro where we are missing
          root access.
        
        
        *************
        Installation
        *************
        
        The simplest method of installation is to use PyPI and pip::
        
            $ pip install msprime --user
        
        will install msprime your user Python installation. This should
        work in most cases (but see the `Requirements`_ section).
        
        To use the ms-compatible command line program, you must ensure
        that the ``~/.local/bin/`` directory is in your ``PATH``.
        
        
        
Keywords: Coalescent simulation,ms
Platform: POSIX
Classifier: Programming Language :: C
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.1
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: POSIX
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
