Skip to main content

A python package that takes an assembly result of a chloroplast genome and continues it by computing the scaffolding stage.

Project description

Khloraa: scaffolding stage

Latest release PyPI version Coverage report Pylint score Mypy Pipeline status Documentation Status

khloraascaf logo

khloraascaf is a Python3 package that implements a dedicated scaffolding method for chloroplast genomes.

From input data files, it computes combinations of Integer Linear Programming (ILP) programs and write the result of the best one in output files.

Please have a look to the documentation website for more details.

Quick installation

To install the khloraascaf package from the PyPI repository, run the pip command :

pip install khloraascaf

You can find more installation details in the docs/src/ file.

Quick usage example

from pathlib import Path

from khloraascaf import SOLVER_CBC, IOConfig, MetadataAllSolutions, scaffolding

# ---------------------------------------------------------------------------- #
# Run the example
# ---------------------------------------------------------------------------- #
# Prepare the scaffolding result directory
outdir = Path('scaffolding_result')
# Compute the scaffolding using the assembly data
outdir_gen = scaffolding(
# khloraascaf creates a directory with a unique name
#   to put all the files it has created
assert outdir_gen in outdir.glob('*')

# ---------------------------------------------------------------------------- #
# Dive into the results
# ---------------------------------------------------------------------------- #
# Use metadata class to easily dive into the results
# (you can also see by hand the solutions.yaml file that has been produced)
all_solutions_metadata = MetadataAllSolutions.from_run_directory(outdir_gen)
# * How many solutions the scaffolding has produced?
#   = 1, let pick its metadata
sol_metadata = tuple(all_solutions_metadata)[0]
# See which files the scaffolding has produced:
files = set(outdir_gen.glob('*'))
assert len(files) == 4
# * The list of oriented contigs for each region
assert sol_metadata.contigs_of_regions() in files
# * The list of oriented regions
assert sol_metadata.map_of_regions() in files
# * YAML file containing all the arguments and options you used
#   to run khloraascaf
assert outdir_gen / IOConfig.YAML_FILE in files
# * YAML file that contains metadata on the solutions
assert outdir_gen / MetadataAllSolutions.YAML_FILE in files


You can refer to the docs/src/ file for details.

What next?

Find a list of ideas in the docs/src/ file.


  • If you find any errors, missing documentation or test, or you want to discuss features you would like to have, please post an issue (with the corresponding predefined template) here.
  • If you want to help me code, please post an issue or contact me. You can find coding convention in the docs/src/ file.


  • A part of the scaffolding method is described in this preprint:

    📰 Victor Epain, Dominique Lavenier, and Rumen Andonov, ‘Inverted Repeats Scaffolding for a Dedicated Chloroplast Genome Assembler’, 3 June 2022,


This work is licensed under a GNU-GPLv3 licence.

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

khloraascaf-1.10.0.tar.gz (79.4 kB view hashes)

Uploaded Source

Built Distribution

khloraascaf-1.10.0-py3-none-any.whl (71.4 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