Installing InteinFinder from source files

Note: If you are not already an OCaml programmer, I recommend that you download one of the precompiled binaries or use the Docker image instead. It is never fun to set up a development environment in a language you are not familiar with!

If you want to compile InteinFinder from source, you need to have a working OCaml development setup.

Additionally, you will need to install GNU Make and the external dependencies that InteinFinder relies on.

Set up OCaml development environment

Instructions to set up an OCaml development environment can be found here or here.

Get the code

Use git to clone the git repository.

$ git clone https://github.com/mooreryan/InteinFinder.git

or download a release from here.

Install OCaml dependencies

cd InteinFinder
opam install . --deps-only --with-doc --with-test

Build, install, & run tests

$ opam exec -- make build_release && opam exec -- make install_release

If you want to run the tests, you can with

$ opam exec -- make install_release

Note that if you have different versions of the external dependencies, then the tests may fail for reasons due to changes in the dependencies (like alignments being slightly different between MAFFT versions).

Sanity check

If all went well, this should give you the path to the InteinFinder executable file.

$ which InteinFinder