Installation¶

This page contains information on how to install ConKit on your local machine or server. A number of different options exist; however, note that the installation via the Python Package Index remains to be the recommended and simplest.

Python Package Index¶

The easiest way to install ConKit is via easy_install or pip. To do so, simply run the following command on your command line and you are ready to go.

To install using easy_install:

$> easy_install conkit  To install using pip: $> pip install conkit


Note

The executable scripts are automatically installed in your default bin directory. There is nothing more that you need to do.

Source Code¶

If you would like to install ConKit from source, download the latest version from the GitHub repository. Then, use the following commands to install ConKit.

$> git clone https://github.com/rigdenlab/conkit$> cd conkit


Once downloaded, you might want to check that all functions are available on your system. Run the following command:

$> python setup.py test  If this has completed successfully, you are good to go and you can now install ConKit. $> python setup.py build install


ConKit is now successfully installed in your system’s default Python.

Note

Similarly to the Python Package Index install, the executable scripts are automatically installed.

External software¶

Note

If you install ConKit via the Python Package Index, the dependencies are automatically installed for you!

Required dependencies¶

Python 2.7, 3.4, 3.5, or 3.6
NumPy 1.8.2 (or later)
BioPython 1.64 (or later)
Matplotlib 1.3.1 (or later)
setuptools
Documentation

Optional dependencies¶

SciPy 0.16 (or later)