Skip to content

kr-colab/ReLocator

Repository files navigation

Documentation Status

Locator

Locator is a supervised machine learning method for predicting the geographic origin of a sample from genotype or sequencing data. A manuscript describing it and its use can be found at https://elifesciences.org/articles/54507

Documentation

Full documentation is available at https://relocator.readthedocs.io/en/latest/.

Quick Install

With pixi (recommended)

Pixi manages all dependencies including TensorFlow and CUDA:

git clone https://github.com/kr-colab/ReLocator.git
cd ReLocator
pixi install              # GPU environment (default)
pixi install -e cpu       # CPU-only environment
pixi run test             # run tests

With pip

pip install locator

Note: when using pip, you must manage TensorFlow and CUDA installation separately.

License

This software is available free for all non-commercial use under the non-profit open software license v 3.0 (see LICENSE.txt).

About

modular API for genetic geolocation using deep neural networks (i.e. version 2 of locator)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors