---
name: "simsearch"
section: "1"
platform: "linux"
package: "python-chemfp"
version: "1.1p1-2.1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/simsearch"
---

# simsearch(1)

simsearch

## NAME

simsearch - simsearch

## DESCRIPTION

usage: simsearch \[-h\] \[-k K\_NEAREST\] \[-t THRESHOLD\] \[-q QUERIES\] \[--NxN\]

-

  \[--hex-query HEX\_QUERY\] \[--query-id QUERY\_ID\] \[--in FORMAT\] \[-o FILENAME\] \[-c\] \[-b BATCH\_SIZE\] \[--scan\] \[--memory\] \[--times\] target\_filename

Search an FPS file for similar fingerprints

### positional arguments:

- target\_filename

  target filename

### optional arguments:

- **-h**, **--help**

  show this help message and exit

- **-k** K\_NEAREST, **--k-nearest** K\_NEAREST

  select the k nearest neighbors (use 'all' for all neighbors)

- **-t** THRESHOLD, **--threshold** THRESHOLD

  minimum similarity score threshold

- **-q** QUERIES, **--queries** QUERIES

  filename containing the query fingerprints

- **--NxN**

  use the targets as the queries, and exclude the selfsimilarity term

- **--hex-query** HEX\_QUERY

  query in hex

- **--query-id** QUERY\_ID

  id for the hex query

- **--in** FORMAT

  input query format (default uses the file extension, else 'fps')

- **-o** FILENAME, **--output** FILENAME

  output filename (default is stdout)

- **-c**, **--count**

  report counts

- **-b** BATCH\_SIZE, **--batch-size** BATCH\_SIZE

  batch size

- **--scan**

  scan the file to find matches (low memory overhead)

- **--memory**

  build and search an in-memory data structure (faster for multiple queries)

- **--times**

  report load and execution times to stderr