daveuu / baga

Bacterial and Archaeal Genome Analyser
GNU General Public License v3.0
9 stars 2 forks source link

How to install the baga module? #1

Open ONeillMB1 opened 8 years ago

ONeillMB1 commented 8 years ago

How does one install the baga module/library?

"ImportError: No module named baga"

daveuu commented 8 years ago

At present baga works best via it's command line interface. (baga_cli.py). I need to restructure the repository slightly and do more testing to allow for conventional module based use. I'll post back here when that is done.

I will put up a manual with a walk-through analysis later this week and fix the importing.

The primary objective was to enable reproduction of a specific analysis (http://dx.doi.org/10.1099/mgen.0.000051). In the meantime the closest thing to a guide are the scripts that accompanied that paper which can be edited and customised from here: http://dx.doi.org/10.6084/m9.figshare.2056359. I recommend to clone and checkout by uncommenting the following lines in 01_setup.sh rather than manually download version 0.2:

{
git clone https://github.com/daveuu/baga.git
cd baga
git checkout 41af21e000bbb5778e9e288f1f99eecf0c12040f
cd ..
} || {
cd baga
git fetch origin
git reset --hard origin/master
git checkout 41af21e000bbb5778e9e288f1f99eecf0c12040f
cd ..
}

Pasting the above into a terminal will also work and allows you to select a specific commit for an analysis - but as you're on github.com you probably know that :-)

(else you'll need to rename "baga-0.2" folder in the version 0.2 download archive to "baga": this is because of the repository restructuring that needs to be done, mentioned above).

Then you can use the command line interface:

baga/baga_cli.py -h baga/baga_cli.py Structure -h

See the other scripts for various commands accompanying the paper for other functionality.

Thanks for your interest, I hope it will be useful.