Skip to content

Strain Authentication and Identification Methods - saim#

release: 0.9.1 MIT LICENSE Documentation Status

main

DOI


saim (Strain Authentication and Identification Methods) is a Python toolkit for reproducible identification, authentication, and metadata handling of microbial strains. It provides utilities for validating strain metadata, harmonizing identifiers, running identification workflows, and exporting results for downstream analysis.


Installation - Development#

Prerequisites#

  • GNU/Linux
  • Docker (optional)
  • Docker Compose (optional)
  • Dev Container CLI (optional)

Steps#

  1. Clone the repository:
    git clone https://github.com/LeibnizDSMZ/cafi.git
    cd cafi
    

Docker#

  1. If using Docker, start the development container manually or use VSCode:

    devcontainer up --workspace-folder .
    devcontainer exec --workspace-folder . bash
    

  2. Create and activate a virtual environment (inside docker the container):

    make dev
    make runAct
    

Local#

  1. Create and activate a virtual environment:
    python -m venv .venv
    source .venv/bin/activate
    
  2. Install the dependencies:
    pip install .
    pip install -r configs/dev/requirements.dev.txt
    pip install -r configs/dev/requirements.test.txt
    pip install -r configs/dev/requirements.docs.txt
    

Contributors#

  • Artur Lissin
  • Julius Witte