Skip to main content

A script for updating a local directory with genomes, from NCBI assembly files

Project description

# genome_update

genome_update is a package that downloads genomes from NCBI and saves information about them in a yaml file. It can also use a local yaml file to update and download new genomes.

## Getting Started

These instructions will provide information how to install and use the software.

### Prerequisites

Python 3.5 Pandas PyYaml

### Installing

To install Genome_update you can either download source code directly from github and build it your self, an easier alternative is to use pip.

Installing by pip:

` pip install genome_update ` Pip will also install all prerequisities. It is also recommended to update the prerequisities.

Installing genome_update and upgrading prerequisities:

` pip install genome_update --upgrade `

### Usage

Simply download all genomes from a specified genus: ` genome_update -g <Genus> `

Download all genomes from a specific genus, but much faster: ` genome_update -g <Genus> -p <threads> `

Download all genomes from a specific genus, but much faster, to a specific directory: ` genome_update -g <Genus> -p <threads> -o <directory> `

Download all genomes from a specific species: ` genome_update -g <Genus> -s <species_taxid> `

To update a local yaml file: ` genome_update -u -i <yamlfile> `

To download missing genomes from a local yaml file: ` genome_update -d -i <yamlfile> `

To download genomes from another domain than bacteria: ` genome_update -domain <domain> -g <Genus> `

## Authors

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

## Acknowledgments

  • Would like to thank kblin for his amazing work with the ncbi_genome_download which provided lots of insipration when writing genome_update.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

genome_update-0.1.6.3.tar.gz (6.3 kB view hashes)

Uploaded Source

Built Distribution

genome_update-0.1.6.3-py3-none-any.whl (10.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page