Skip to main content

Apscale Installer

Important changes

  • APSCALE4 is now implement in APSCALE-GUI [22.08.2025]
  • Please update the environment to "apscale4" (upgraded to python3.12)
  • The original "apscale" environment is outdated (python3.10 is no longer supported).

Introduction

The easiest way to install the apscale metabarcoding workflow is by using Miniconda3. Miniconda will create an isolated environment with all the suggested versions of each tool.

Note: Currently, vsearch and blast+ cannot be automatically installed via conda. For now, the easiest solution is the installation through the apscale-installer script. We will update this Wiki when vsearch and blast+ are available via conda. Linux users can install vsearch and blast+ already now using conda.

This tutorial will install the following tools:

Miniconda Installation

  1. Install Miniconda by following the instructions.

  2. Open a new Anaconda (Miniconda3) terminal.

    • Windows: Type 'Anaconda' in your search bar and select 'Anaconda Powershell Prompt (miniconda3)'.
    • MacOS: Open a new terminal. You will see the (base) environment before your user name.
  3. Download the respective environment installation file for Windows or MacOS.

  4. Install the metabarcoding environment by typing:

    conda env create -f apscale_env_windows_aarch64.yml
    
  5. This should automatically install all dependencies. After the installation, activate the environment:

    conda activate apscale4
    
  6. Windows and MacOS users run the apscale-installer script:

    apscale_installer
    
  7. Linux and MacOS (intel) users can use conda:

    conda install bioconda::vsearch
    conda install bioconda::blast
    playwright install
    
  8. Verify your installations:

    vsearch --help
    blastn -h
    
  • If you want to uninstall the old apscale environment type:
    conda remove -n apscale --all
    

Miniconda Installation (manual)

  • If the yml installation of the environment fails a manual installation can be performed:

    conda create -n apscale4 python=3.12 ipython
    conda activate apscale4
    pip install apscale
    pip install apscale_gui
    pip install apscale_installer
    pip install apscale_blast
    pip install boldigger3
    pip install demultiplexer2
    apscale_installer
    

Usage

Now that everything is installed, you can use the installed software.

Refer to the homepages of each program to run learn how to use them:

Video tutorial

There is also a YouTube tutorial available, where the installation of Windows and MacOS is demonstrated.

Metadata

Release files for apscale-installer 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apscale-installer 1.0.1
File Size Uploaded
apscale_installer-1.0.1.tar.gz 5.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for apscale-installer 1.0.1
File Interpreter ABI Platform
apscale_installer-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 10.5 kB

Release files / apscale_installer-1.0.1.tar.gz

Download URL apscale_installer-1.0.1.tar.gz
Size 5.0 kB
Tags Source
SHA-256 checksum
How to use checksums
bdfae81d4712ae1c6f77a988f06cd200320c50503aa76c2bb0017ef55ea31689
BLAKE2b-256 checksum
How to use checksums
8c8eacdbff370c49127aaaad2c2f0c4db1228874f6c4707825c012e070d17d2c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.4

Release files / apscale_installer-1.0.1-py3-none-any.whl

Download URL apscale_installer-1.0.1-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
65ba6132de1c72f829e4106bfb49018eb1e7a0b246d9e4afe85ef4a4bb773aac
BLAKE2b-256 checksum
How to use checksums
9b43de1fe3cc33ed5e07333f991fc6cbd054b63a6ecfe5a14fa0ec5c398fdd8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.4

Release history Release notifications | RSS feed

1.0.2

2 release files

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.5

2 release files

0.4

2 release files

0.3

2 release files

0.2

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page