Sign inSign up

rfpacheco/blastoise

By rfpacheco

•Updated 9 months ago

BLAST Oriented to the Identification of SIDER Elements

Image
0

1.2K

rfpacheco/blastoise repository overview

⁠BLASTOISE: BLAST Oriented to the Identification of SIDER Elements (Docker Edition)

⁠BLASTOISE: BLAST Oriented to the Identification of SIDER Elements

BLASTOISE is a Python-based software tool engineered to automate the identification of SIDER (Short Interspersed Degenerated Retroposon) elements within the genomes of Leishmania spp. species. The inherent heterogeneity and degeneration of these retroposons present considerable identification challenges, which BLASTOISE is designed to overcome.

The software is distributed through several channels:

⁠Cross-Platform Compatibility

The BLASTOISE Docker image is built on a Linux base, but thanks to Docker's containerization technology, it runs seamlessly on any major operating system, including Windows, macOS, and Linux.

All you need is Docker Desktop (for Windows and Mac) or Docker Engine (for Linux) installed on your system. The web interface is accessed through your local web browser, providing a consistent experience regardless of your OS.

⁠Primary Use Method: Web Application

The BLASTOISE Docker image comes with a comprehensive web application, powered by the FastAPI framework, that provides an intuitive graphical user interface for interactive analysis. This is the recommended way to use BLASTOISE with Docker.

⁠Installation

Using Docker is the recommended approach as it runs on Windows, macOS, and Linux, simplifying dependency management and ensuring a consistent runtime environment.

⁠Method 1: Docker Desktop (Windows and macOS)

For users on Windows and macOS, the simplest way to get the image is by using the Docker Desktop graphical interface:

  1. Install Docker Desktop: Download and install it from the official Docker website.
  2. Search for the image: Open Docker Desktop, go to the "Images" section, and search for rfpacheco/blastoise in the search bar.
  3. Pull the image: Click the "Pull" button to download the image from Docker Hub.
⁠Method 2: Command-Line (All Platforms)

On any platform (including Linux), you can use the command line.

  1. Install Docker: Ensure that Docker Desktop (for Windows and macOS) or Docker Engine (for Linux) is installed.
  2. Pull the Docker Image: Open your terminal and run the following command. You may pull the :latest tag for the most recent version or a specific version tag for reproducibility.
# Pull the latest version
docker pull rfpacheco/blastoise:latest

# Or, pull a specific version (e.g., 0.4.3)
docker pull rfpacheco/blastoise:0.4.3

⁠Usage

Once the image is pulled, you can run the container to start the web application.

⁠Method 1: Docker Desktop (Windows and macOS)
  1. Run the image: In Docker Desktop, go to the "Images" section, find the rfpacheco/blastoise image, and click the "Run" button.
  2. Configure port: In the "Optional settings", set the "Host port" to 8000. This maps the container's port 8000 to your local machine's port 8000.
  3. Run the container: Click "Run".
  4. Access the Web Interface: Navigate to http://localhost:8000 in a web browser.
⁠Method 2: Command-Line (All Platforms)
  1. Run the Container: Execute the following command to start the container and the web server. The -p 8000:8000 flag maps the container's internal port to the host machine.

    docker run --rm -p 8000:8000 rfpacheco/blastoise:latest
    
  2. Access the Web Interface: Navigate to http://localhost:8000 in a web browser.

⁠Using the Web Application

Once running, you can:

  1. Upload the requisite input files (query data and genome).
  2. Configure the analysis parameters as necessary.
  3. Initiate the job by selecting "Run BLASTOISE" or "Run SIDER Filter".
  4. Upon completion, the results will be available for download.
⁠2. Command-Line Interface (Advanced)

It is also possible to execute CLI commands directly via Docker by overriding the container's default command. This procedure requires mounting local data directories into the container's filesystem using the -v flag.

blastoise (Main Discovery Tool) Example:

# Example: Execute the main 'blastoise' tool via Docker
docker run --rm \
 -v /path/to/your_data:/app/data \
 -v /path/to/your_output:/app/output \
 rfpacheco/blastoise:latest \
 blastoise -d /app/data/query.fasta -g /app/data/genome.fasta -o /app/output/my_results

blastoise-sider-filter (Validation Tool) Example:

docker run --rm \
 -v /path/to/your_data:/app/data \
 -v /path/to/your_output:/app/output \
 rfpacheco/blastoise:latest \
 blastoise-sider-filter -d /app/data/candidates.csv -g /app/data/genome.fasta -rf /app/data/query.fasta

Note on Paths: When using the CLI with Docker, all paths for input and output arguments (-d, -g, -o, -rf, etc.) must correspond to the paths inside the container (e.g., /app/data, /app/output).

⁠Dependencies

All necessary dependencies (Python, BLAST, and required libraries) are pre-installed in the Docker image. No further installation is required on the user's part.

⁠License

BLASTOISE is open-source software distributed under the terms of the MIT License.

⁠Citation

Should you use BLASTOISE in your research, we kindly request that you cite the following publication:

@software{Pacheco_BLASTOISE_2025,
author = {Pacheco, R.},
title = {{BLASTOISE: BLAST Oriented to the Identification of SIDER Elements}},
year = {2025},
publisher = {GitHub},
journal = {GitHub repository},
url = {https://github.com/rfpacheco/BLASTOISE}
}

⁠Contact

For inquiries, bug reports, or contributions, please use the following channels:

Tag summary

Content type

Image

Digest

sha256:13cebc465…

Size

1.3 GB

Last updated

9 months ago

docker pull rfpacheco/blastoise