Welcome to Horus documentation!

Installing Horus

• Introduction to Horus
  • What is Horus?
• Downloading and installing Horus
  • macOS Installation
  • Linux Installation
    • For Ubuntu 22 and Up
    • For Other Linux
  • Windows
  • Other systems

Running Horus

• Running Horus
  • Launching Horus
    • For macOS and Ubuntu 22+
  • Command Line Options
  • Environment Variables
  • App Mode (Default Mode)
  • Browser Mode
  • Server Mode
  • WebApp Mode
• Security considerations

Installing plugins

• Installing Plugins
  • Understanding Plugins
  • Installing a Plugin
  • Example

Running flows

• Runing flows
  • The execute block button
    • Basic Usage
    • Reset flow and execute block
  • Types of flows
    • Branch-less flows
    • Branched flows
    • Cyclic flows

FAQ

• FAQ & Issues
  • Why aren’t all the chains/ligands/residues of my PDB visible in the flow selector?
  • How can I reset all the outputs of the blocks in my flow?
  • How do I know if two blocks are correctly connected?
  • Flows Stuck in “Queued” State and Application Crashes on macOS
  • Error importing libraries in Linux
• Contribute

Building Horus plugins

• Developer guide
  • Introduction
  • Usage
    • Installation
    • Plugins
    • Variables
    • Blocks
    • Extensions
    • Predefined Flows
    • RemoteAPI
    • Molstar (Mol*)
    • Smiles

The Horus plugin

• Default Horus Plugin
  • Default blocks
  • Default extensions

Web App mode

• WebApp mode
  • Configuration File
  • Public flows
  • Security concerns

API Reference

• Source code

Citing & License

• Citing & License