Command Line Interface (CLI)

sdf-convert

The tool sdf-convert converts files to the SDF format. Use sdf-convert --help for details and examples:

usage: sdf-convert [-h] [-i {SDF,JPK,MFP,OIB,OIF,LSM,FORCE_SDF,JPK_MAP}]
                   [-o OUTPUT_DIRECTORY] [--no-force] [--mat] [-p] [-v] [-d]
                   [-s] [--dry-run]
                   input-files [input-files ...]

Converts files into .sdf and possibly additional formats. See details and examples below.

positional arguments:
  input-files           Files to convert

optional arguments:
  -h, --help            show this help message and exit
  -i {SDF,JPK,MFP,OIB,OIF,LSM,FORCE_SDF,JPK_MAP}, --input-format {SDF,JPK,MFP,OIB,OIF,LSM,FORCE_SDF,JPK_MAP}
                        Input format (default: infer for each file)
  -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
                        The output directory (default: same as input files)
  --no-force            Generate no additional .force.sdf file (only for force
                        distance curves)
  --mat                 Generate an additional .mat file (only for force
                        distance curves)
  -p, --progress        Show progress
  -v, --verbose         Set logging level to INFO
  -d, --debug           Set logging level to DEBUG (implies --verbose)
  -s, --silent          Set logging level to ERROR (silences warnings)
  --dry-run             Perform conversions without writing the results

additional formats:
    if input is force distance curve (currently supported for .ibw and .jpk-force files)
        .force.sdf (unless --no-force is set)
        .mat (if --mat is set)

examples:
    sdf-convert *.lsm
        converts all .lsm files in the current directory to .sdf
        results will be placed alongside the original files

    sdf-convert *.jpk-force -o sdf
        converts all .jpk-force files to .sdf and .force.sdf
        results will be placed in directory ./sdf

    sdf-convert *.jpk-force --no-force --mat
        converts all .jpk files to .sdf and .mat

    sdf-convert *
        converts all files in the current directory to .sdf (and .force.sdf, if possible)
        infers input type from individual file extension (fails for invalid inputs like .mat files)

    sdf-convert --input-format OIB oib-file-without-extension
        reads file `oib-file-without-extension` as .oib file and converts it to .sdf

sdf-update

The tool sdf-update updates the current SDF installation by downloading the zip file from GitLab, uninstalling the current SDF installation and then installing the downloaded version. Use sdf-update --help for details:

usage: sdf-update [-h] [-b VERSION | -c VERSION]

Update the SDF installation

optional arguments:
  -h, --help            show this help message and exit
  -b VERSION, --branch VERSION
                        Branch to install (default: stable)
  -c VERSION, --commit VERSION
                        Commit to install (full SHA hash)