Skip to main content

Interactive GUI for inSPIRE Platform.

Project description

inSPIRE-interactive

Easy GUI/webserver access for the inSPIRE platform.

drawing

Set Up

Before Downloading

We recommend working with inSPIRE through conda. On windows systems you may also need

Setting up your environment:

For basic inSPIRE-Interactive use.

  1. To start with create a new conda environment with python version 3.11:
conda create --name inspire python=3.11
  1. Activate this environment
conda activate inspire
  1. You will then need to install the inSPIRE-interactive package (this also installs inSPIRE):
pip install inspire-interact==0.6
  1. To check your installation, run the following command (it is normal for this call to hang for a few seconds on first execution)
inspire-interact -h
  1. You will require Percolator for rescoring. On Linux, Percolator can be installed via conda with the command below. Otherwise see https://github.com/percolator/percolator.
conda install -c bioconda percolator
  1. Once you have successfully installed inSPIRE-Interactive you should run it specifying your pipeline and the mode of execution. The core execution of inSPIRE will take the form:
inspire-interact --config_file path-to-config-file --mode local

where the config file is a yaml file specifying configuration of your inSPIRE-Interactive server and the mode is either "server" if you are setting up inSPIRE-Interactive for use throughout your lab, or "local" if you are only using inSPIRE-Interactive on your own machine.

  1. On local mode you can then access the webserver home by pasting the following address on your browser:
http://127.0.0.1:5000/interact-page/home

Additional Features

In order to use raw files on Linux or Mac O.S. you will require the use of mono (mono project) which is required by the ThermoRawFileParser. (The ThermoRawFileParser itself is open source and downloaded by inSPIRE.)

In order to use NetMHCpan for binding affinity prediction you should download the software from the DTU site (you must agree to the license agreement). On linux and maxos systems we typically use tcsh. If you are a windows user you should download the Linux distribution and will need to install docker (see docker documentation.

In order to use MSFragger within inSPIRE-Interactive you should download from MSFragger (you must agree to the license agreements). You will also need java which can be installed using:

conda install -c conda-forge openjdk

In order to use Skyline within inSPIRE-Interactive you will need to download docker and insure can be run within inSPIRE. See instructions from docker documentation. (Skyline itself is open source).

Writing the Config File.

The following configurations should be set for inSPIRE-interactive:

Key Description
maxInspireCpus The number of CPUs from your computer that you wish to dedicate to inSPIRE execution.
fraggerPath The file path to the .jar file of MSFragger (e.g. for version 3.7 the end of this path should be: MSFragger-3.7/MSFragger-3.7.jar)
fraggerMemory The ammount of memory (GB) that is available for MSFragger execution.
netMHCpan The command that can be used to run NetMHCpan (e.g. on Linux we use tcsh to execute NetMHCpan and so our config key is tcsh /data/inSPIRE-Server/netMHCpan-4.1/netMHCpan).

Example of Windows Config

---
fraggerPath: C:/Users/username/Downloads/MSFragger-3.7/MSFragger-3.7.jar
netMHCpan: C:/Users/username/Downloads/netMHCpan-4.1
fraggerMemory: 60
maxInspireCpus: 20
skylineRunner: C:/Program Files/Skyline/SkylineRunner.exe
rescoreCommand: C:/Program Files/percolator-v3-05/bin/percolator.exe

Example of Linux/MacOS Config

---
fraggerPath: /Users/username/Downloads/MSFragger-3.7/MSFragger-3.7.jar
netMHCpan: /Users/username/Downloads/netMHCpan-4.1
fraggerMemory: 60
maxInspireCpus: 20

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

inspire_interact-0.6.tar.gz (811.9 kB view details)

Uploaded Source

Built Distribution

inspire_interact-0.6-py3-none-any.whl (822.6 kB view details)

Uploaded Python 3

File details

Details for the file inspire_interact-0.6.tar.gz.

File metadata

  • Download URL: inspire_interact-0.6.tar.gz
  • Upload date:
  • Size: 811.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for inspire_interact-0.6.tar.gz
Algorithm Hash digest
SHA256 7d3d14aad4cda88e87acbd2003e4dc2d5efed5fb3be80ff6829d8969be092f7a
MD5 e51c8a6df4e8ba6a2c668fcd47fd7aa8
BLAKE2b-256 9606f59923ba08b3b5ce6eed159f154c745007f9ef23e6fb98e11fbd69b08984

See more details on using hashes here.

File details

Details for the file inspire_interact-0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for inspire_interact-0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b18adafdcfcef46cd1383e0091ccf2b03d55323553768e09034438a34d002cc7
MD5 3607340b825da810ad0e737f27c41d3d
BLAKE2b-256 1dd20ea986154871cdc74b4855301a6be4fa5f2d35924f5ad99df0fe1e524d8a

See more details on using hashes here.

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