Skip to main content

Command line interface for uploading fastq files and monitoring minKNOW for minotour.

Project description

A command line client for uploading sequencing metrics from Oxford Nanopore Technologies MinKNOW to a LooseLab minoTour server instance.

MinFQ only supports minknow core 4.X.X as it uses ONT’s minknow-api, which is only compatible with said version of MinKNOW.

However, base called data can be uploaded from any version of MinKNOW/Guppy.

To install -

pip install minFQ

Example Commands

In the example commands below example parameters are:

  • your_user_key: is the long string found in the profile section of your minoTour account.

  • url_to_your_minotour_server: Probably 127.0.0.1, could be a remote address like minotour.nottingham.ac.uk

  • port_for_your_server: Probably 8000

To monitor both live and fastq data.

minFQ -k [your_user_key] -w /path/to/your/fastq/files -ip 127.0.0.1 -hn
[url_to_your_minotour_server] -p [port_for_your_server]

To monitor just live data from minKNOW.

minFQ -k [your_user_key] -ip 127.0.0.1 -hn [url_to_your_minotour_server]
-p [port_for_your_server] -nf

To monitor live data and enable limited remote control of minKNOW.

minFQ -k [your_user_key] -ip 127.0.0.1 -hn [url_to_your_minotour_server]
-p [port_for_your_server] -nf -rc

To monitor just fastq data.

minFQ -k [your_user_key] -w /path/to/your/fastq/files -hn [url_to_your_minotour_server]
-p [port_for_your_server] -nm

To monitor fastq statistics only. (Note you will not be able to run subsequent analysis on the server which requires sequence data).

minFQ -k [your_user_key] -w /path/to/your/fastq/files -hn [url_to_your_minotour_server]
-p [port_for_your_server] -nm -s

To start an analysis remotely whilst uploading data. Note reference Id may not be required.

minFQ -k [your_user_key] -w /path/to/your/fastq/files -hn [url_to_your_minotour_server]
 -p [port_for_your_server] -nm -j [job_id] -r [reference_id]

minFQ Gui

We are in the process of rebuilding a minFQ gui. Watch this space.

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

minFQ-1.4.7.tar.gz (37.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minFQ-1.4.7-py3-none-any.whl (66.3 kB view details)

Uploaded Python 3

File details

Details for the file minFQ-1.4.7.tar.gz.

File metadata

  • Download URL: minFQ-1.4.7.tar.gz
  • Upload date:
  • Size: 37.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for minFQ-1.4.7.tar.gz
Algorithm Hash digest
SHA256 685bfb6e3c4a30172e7e884bb72364849a7808099afa13240f5681f82c2e6aa7
MD5 aa08d521128c12c512ea5913f5d19544
BLAKE2b-256 f1d3a2087265819052338ccba9457caae60a7c12fe1589443c5d301dafaa71e8

See more details on using hashes here.

File details

Details for the file minFQ-1.4.7-py3-none-any.whl.

File metadata

  • Download URL: minFQ-1.4.7-py3-none-any.whl
  • Upload date:
  • Size: 66.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for minFQ-1.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 70e454695d66b4b57ec5170ed1fa072ed9e54eda2922167e00507b905ebd3daa
MD5 814a3fc54ca0cdbb17a727d4fdd4cf9d
BLAKE2b-256 0ef85fd19d17b372ebc7ac56365877643b1a7946430c9d526555d131c4e9a41e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page