Command Line Interface Reference

msstools

msstools [OPTIONS] COMMAND [ARGS]...

Options

--install-completion: Install completion for the current shell.

--show-completion: Show completion for the current shell, to copy it or customize the installation.

bibtex

Display the BibTeX entry for this software.

msstools bibtex [OPTIONS]

cite

Display the citation for this software. If you use this software in your research, please cite the article.

msstools cite [OPTIONS]

combine

Combine a list of images into a PDF with an outline based on the image filenames.

msstools combine [OPTIONS] IMAGE_PATHS... OUTPUT_PDF

Options

--strip-pattern <strip_pattern>

Optional regex pattern to ignore in folio labels

Default:

Arguments

IMAGE_PATHS: Required argument(s) List of image paths to combine into a PDF <typer.models.TyperPath object at 0x7f7a26623850>

OUTPUT_PDF: Required argument Path to the output PDF file <typer.models.TyperPath object at 0x7f7a26623710>

compare-counts

Compares homily transcriptions with a base text and visualizes where text is missing

msstools compare-counts [OPTIONS] BASE_PREFIX COMPARISON_PREFIX

Options

--output-svg <output_svg>: Path to save the output as an SVG file

--start-homily <start_homily>

The number of the homily to start with

Default:: 0

--end-homily <end_homily>

The number of the homily to end with

Default:: 32

--threshold <threshold>

The number of characters which the comparison text sentence can be above the base text sentence before triggering the warning indication

Default:: 50

Arguments

BASE_PREFIX: Required argument The prefix for files of the base text STRING

COMPARISON_PREFIX: Required argument The prefix for files of the comparison text STRING

count-greek-chars

Count Greek characters in text files and generate a plot.

msstools count-greek-chars [OPTIONS] FILENAME_PREFIX

Options

--start-homily <start_homily>

The number of the homily to start with

Default:: 0

--end-homily <end_homily>

The number of the homily to end with

Default:: 32

--warning-stdev <warning_stdev>

Standard deviation threshold for warnings

Default:: 1.8

--output <output>: Path to save the output plot

--show, --no-show

Show the plot in a window

Default:: False

Arguments

FILENAME_PREFIX: Required argument Prefix for the output files STRING

csv-to-tei

Convert a CSV file of readings into TEI XML format.

msstools csv-to-tei [OPTIONS] INPUT_CSV OUTPUT_XML

Options

--dates <dates>: Optional path to a file containing dates

--max-readings <max_readings>

Maximum number of readings to process at each variation unit

Default:: 0

Arguments

INPUT_CSV: Required argument The path to the input CSV file containing readings <typer.models.TyperPath object at 0x7f7a266243d0>

OUTPUT_XML: Required argument The path to the output XML file <typer.models.TyperPath object at 0x7f7a26624290>

number-sentences

Number <S> sentence tags within <P> blocks in a text file.

msstools number-sentences [OPTIONS] INPUT_FILE OUTPUT_FILE

Arguments

INPUT_FILE: Required argument Path to the input file <typer.models.TyperPath object at 0x7f7a26635150>

OUTPUT_FILE: Required argument Path to the output file <typer.models.TyperPath object at 0x7f7a26634490>

remove-accents

Remove accents from a text file.

msstools remove-accents [OPTIONS] INPUT_FILE OUTPUT_FILE

Arguments

INPUT_FILE: Required argument Path to the input file <typer.models.TyperPath object at 0x7f7a26627fd0>

OUTPUT_FILE: Required argument Path to the output file <typer.models.TyperPath object at 0x7f7a26634f10>

split-images

Split an image into recto and verso parts.

msstools split-images [OPTIONS] PREFIX IMAGES...

Options

--rtl, --no-rtl

Split images in right-to-left direction

Default:: False

--overlap <overlap>

Overlap percentage between split images

Default:: 10

--skip <skip>

Number of pages to skip before splitting

Default:: 0

--margin-left <margin_left>

Margin to remove from the left side of the image before splitting

Default:: 0

--margin-right <margin_right>

Margin to remove from the right side of the image before splitting

Default:: 0

--force, --no-force

Force overwrite existing files

Default:: False

--recto <recto>: Recto folio anchors in the form FILENAME=FOLIO

--ignore <ignore>: List of image filenames to ignore

Arguments

PREFIX: Required argument Path to the image file to be split <typer.models.TyperPath object at 0x7f7a26624c10>

IMAGES: Required argument(s) List of image files to be split <typer.models.TyperPath object at 0x7f7a26627d90>

version

Display the version of this software.

msstools version [OPTIONS]