Giter VIP home page Giter VIP logo

pll-modules-1's Introduction

pll-modules

High Level modules for the Low Level Phylogenetic Likelihood Library

Introduction

Clone & compile

PLL-Modules depends on the PLL library submodule (libs/libpll), so you have to clone the repository as follows:

git clone --recursive https://github.com/ddarriba/pll-modules

or

git clone https://github.com/ddarriba/pll-modules
git submodule update --init --recursive

To compile and install module with the bundled version libpll, run:

./install-with-libpll.sh [TARGET_DIR]

Alternatively, if you want to use a different version of libpll, you can run:

./autogen.sh
./configure CPPFLAGS="-Ipath/to/libpll" LDFLAGS="-Lpath/to/libpll"
make
make install    # as root, otherwise run: sudo make install

The library will be installed on the operating system's standard paths. For some GNU/Linux distributions it might be necessary to add that standard path (typically /usr/local/lib) to /etc/ld.so.conf and run ldconfig.

Microsoft Windows compatibility was tested with a cross-compiler and seems to work out-of-the-box using MingW.

Documentation

PLL-Modules is documented with Doxygen. Run the following command to generate the API description in HTML and LaTeX formats:

doxygen doxy.cfg

Afterwards, the html API documentation is available at doc/html/index.html. Additionally, you can generate pdf documentation by compiling the LaTeX output:

cd doc/latex
make

Usage examples

Please refer to the wiki page and/or the examples directory.

Documentation

Please refer to the wiki page.

Available functionality

Below is a list of available modules in the current version. Check each individual README.md file in the correspondent subdirectory for more information.

Module Prefix Description
binary pllmod_bin_ Binary I/O
msa pllmod_msa_ MSA management
optimize pllmod_opt_ Optimization algorithms
tree pllmod_tree_ Tree management
util pllmod_util_ Convenience functions
algorithm pllmod_algo_ High level algorithms

pll-modules-1's People

Contributors

amkozlov avatar pierrebarbera avatar benoitmorel avatar ddarriba avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.