Installation

CREDTOOLS requires Python 3.9 or higher. The base installation includes all dependencies needed for fine-mapping analysis.

Basic Installation

To install the base CREDTOOLS package, run this command in your terminal:

$ pip install credtools

This is the preferred method to install CREDTOOLS, as it will always install the most recent stable release.

Development Installation

For development, you may want to install CREDTOOLS in "editable" mode:

$ git clone https://github.com/Jianhua-Wang/credtools.git
$ cd credtools
$ pip install -e .

Check that CREDTOOLS is installed correctly:

$ credtools --help

Conda Installation

You can also install CREDTOOLS using conda:

$ conda install -c conda-forge credtools

Source

The source for CREDTOOLS can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/Jianhua-Wang/credtools

Or download the tarball:

$ curl -OJL https://github.com/Jianhua-Wang/credtools/tarball/master

Once you have a copy of the source, you can install it with:

$ cd credtools
$ pip install -e .

Troubleshooting

If you encounter any issues during installation, please check:

1. Python version (3.9+ required)
2. pip is up to date
3. You have write permissions for the installation directory

Links