Low-Latency Algorithm for Multi-messenger Astrophysics (LLAMA)
3.4.16

Info for Reviewers

  • Introduction for Reviewers
  • Purpose
  • Documentation
    • Software Documentation
    • Review Wikis
    • Papers
    • Source Code
  • Testing on Review Server
    • Fake cases
    • Running Fake Cases
  • Contents of the Output Folder
    • Inputs
    • Main Outputs
    • Auxilliary Outputs
    • Real cases

Quick Start Guide

  • Using the Docker Images
    • Installing Docker
    • Docker Cloud
    • Getting LLAMA Images
      • Choosing the Image
      • Getting/Updating the Image
      • Removing Images
    • Running a LLAMA Container
    • Mounting Directories
      • Mounting in MacOS/Linux
      • Mounting in Windows
    • Out of Memory/Disk
  • Running on Habanero
    • Interactive Habanero Jobs
    • Docker Hub Authentication with Singularity
    • Fixing Singularity Cache on Habanero
    • Load Singularity Module
    • Pull LLAMA Image
  • Local Installation
    • System Requirements
    • Installing Conda
  • Setting Up a Production Server
    • Install Docker
    • Install Docker Compose
    • Log in to Docker Cloud
    • Get docker-compose.yml
    • Starting LLAMA Production App

Operators' Guide

  • Introduction
  • How Data is Organized
    • Event Directories
    • GCN Notice Archive
    • Log Files
  • Running the Pipeline Automatically
  • Running the Pipeline Manually
    • Using Defaults with skymap_info
  • Sensitivity and Background Studies (O3B)
  • Sensitivity and Background Studies (pre-O3B)
    • Editing your .bashrc
      • Using the DigitalOcean API
    • LLAMA Scripts
    • Adding Your SSH Keys to the Droplets
    • Installing Requirements
    • DigitalOcean Administration Examples
      • Preparing a Server
    • Server Preparation Overview
    • Moving Data into Place
      • Running the Analysis in Parallel
    • Starting the Servers
    • Running the Analysis
    • Collecting Results

Developer's Guide

  • Developer Installation
    • Obtaining the LLAMA Source Code
    • Using the Docker Dev Image
      • List bin/docker Commands
      • Getting the Latest Development Image
      • Starting a Dev Container
      • Sketch of a Bug Fix
      • Destroying your Dev Container
  • Previous LLAMA Versions
    • Developer Installation (Pre-O3)
      • System Requirements
      • Introduction
      • Installing LLAMA Dependencies
      • Obtaining the LLAMA Software (pre-O3)
      • Setting up Configuration Files
      • Install git Hooks
      • Install LLAMA dependencies
      • Install LIGO Software
      • Install IceCube Offline Software
        • Installing IceCube Dependencies
        • Entering IceCube Credentials
      • Install MATLAB
    • Configuration and Authentication
      • Generate SSH Keys
      • GMail Authentication
      • LIGO Authentication
      • Setting Up SSL Certificates
      • Setting Up Passwords for Run Summary Pages
    • External Authentication
      • Bitbucket Authentication
      • git.ligo.org Authentication
      • Twilio Authentication
      • GW Astronomy Authentication
      • GCN Authentication
    • Turning on the Pipeline
      • Subscribing to LVAlert Nodes
      • Starting Pipeline Daemons
        • Testing LVAlert
      • Viewing Active Processes
      • Checking Pipeline Logs
      • Killing Pipeline Daemons
      • Deprecated: MATLAB Logs
    • Developing for LLAMA
      • Introduction to Development
        • Structure of the Pipeline
        • Adding Functionality
      • Developer Conventions and Best Practices
        • Data Format Conventions
        • Coding Best Practices
      • Testing
    • Appendix
      • Migrating to Conda
        • LIGO Wiki Documentation
        • Installing LIGO Software via Conda
      • Troubleshooting Installation
        • Creating a new user
        • Out of Memory
        • MATLAB Installation Troubleshooting
      • Install IceCube Offline Software with Root
      • Installing Ubuntu for Windows
      • Logging in to a Remote Server Using SSH
      • Getting LLAMA Software onto a Remote Server
      • SSH with X11 Forwarding
      • Using LLAMA
      • Documenting LLAMA
        • Overview
        • Publishing to gwhen.com Website
        • Publishing Readme to Git Host
        • Publishing PDFs
        • Publishing HTML Web Pages
      • Troubleshooting LLAMA
      • Setting Up the Review Server
        • Provisioning the review server
        • Running the Review
      • Ideas for the Future
      • CVMFS
        • Advantages
        • Disadvantages

Bibliography

  • Academic Papers
    • Low-Latency Algorithm for Multi-messenger Astrophysics (LLAMA) with Gravitational-Wave and High-Energy Neutrino Candidates
    • Bayesian Multi-Messenger Search Method for Common Sources of Gravitational Waves and High-Energy Neutrinos

API Documentation

  • llama package
  • llama.batch package
  • llama.classes module
  • llama.cli module
  • llama.com package
    • llama.com.dl package
    • llama.com.do package
    • llama.com.email package
    • llama.com.gracedb package
    • llama.com.s3 package
    • llama.com.slack package
    • llama.com.utils module
  • llama.detectors module
    • Available Detectors
  • llama.dev package
    • llama.dev.background package
      • llama.dev.background.pvalue package
      • llama.dev.background.table package
      • llama.dev.background.table_singles package
    • llama.dev.clean package
    • llama.dev.data package
      • llama.dev.data.i3 package
    • llama.dev.docs package
      • llama.dev.docs.cli package
    • llama.dev.dv package
    • llama.dev.log package
      • llama.dev.log.lvalert package
    • llama.dev.upload package
  • llama.event package
  • llama.filehandler package
    • llama.filehandler.mixins module
  • llama.files package
    • llama.files.coinc_significance package
      • llama.files.coinc_significance.opa module
      • llama.files.coinc_significance.subthreshold module
      • llama.files.coinc_significance.utils module
    • llama.files.healpix package
      • llama.files.healpix.plotters module
      • llama.files.healpix.psf module
      • llama.files.healpix.skymap module
      • llama.files.healpix.utils module
    • llama.files.i3 package
      • llama.files.i3.json module
      • llama.files.i3.realtime_tools_stubs module
      • llama.files.i3.tex module
      • llama.files.i3.txt module
      • llama.files.i3.utils module
    • llama.files.lvc_skymap package
      • llama.files.lvc_skymap.utils module
    • llama.files.skymap_info package
      • llama.files.skymap_info.cli module
      • llama.files.skymap_info.utils module
    • llama.files.slack package
    • llama.files.advok module
    • llama.files.coinc_analyses module
    • llama.files.coinc_o2 module
    • llama.files.coinc_plots module
    • llama.files.fermi_grb module
    • llama.files.gcn_draft_o2 module
    • llama.files.gracedb module
    • llama.files.gwastro module
    • llama.files.lvalert_advok module
    • llama.files.lvalert_json module
    • llama.files.lvc_gcn_xml module
    • llama.files.lvc_skymap_mat module
    • llama.files.lvc_skymap_txt module
    • llama.files.matlab module
    • llama.files.sms_receipts module
    • llama.files.team_receipts module
    • llama.files.timing_checks module
    • llama.files.uw_summary module
    • llama.files.ztf_trigger_list module
  • llama.flags package
    • llama.flags.cli module
  • llama.install package
    • llama.install.manifest module
  • llama.intent module
  • llama.listen package
    • llama.listen.gcn package
    • llama.listen.lvalert package
  • llama.lock module
  • llama.meta module
  • llama.pipeline module
    • Pipelines
  • llama.poll package
    • llama.poll.gracedb package
  • llama.run package
  • llama.serve package
    • llama.serve.gui package
      • llama.serve.gui.wsgi package
      • llama.serve.gui.domain module
    • llama.serve.jupyter package
      • llama.serve.jupyter.logs module
      • llama.serve.jupyter.utils module
  • llama.test package
    • llama.test.test_files package
    • llama.test.test_listeners package
      • llama.test.test_listeners.test_gcn module
    • llama.test.classes module
    • llama.test.test_bin module
    • llama.test.test_filehandler module
    • llama.test.test_pipeline module
    • llama.test.test_utils module
  • llama.utils module
  • llama.version module
  • llama.versioning module
  • llama.vetoes module

Code Reports

  • Unit Tests
  • Code Coverage
  • Performance Profiling
    • Combined Results
      • combined
    • Unit Tests
      • test
      • test_default_pipeline_consistency
      • test_filehandler_definition_consistency
      • test_get_grid_make_grid
      • test_get_grid_north_pole
      • test_llama_pipeline_parser
      • test_llama_run_parser
      • test_memoize
      • test_memoize_class
      • test_memoize_helper
      • test_mjd_interval
      • test_rotate_angs2vec
      • test_write_gzip
    • Doctests
      • llama.com
        • llama.com.gracedb
          • llama.com.gracedb.GraceDb
      • llama.dev
        • llama.dev.data
          • llama.dev.data.i3
        • llama.dev.upload
          • llama.dev.upload.upload_and_get_manifest
      • llama.event
        • llama.event.Event
          • llama.event.Event.printstatus
      • llama.filehandler
        • llama.filehandler.JSONFile
          • llama.filehandler.JSONFile.checksum
      • llama.files
        • llama.files.fermi_grb
          • llama.files.fermi_grb.get_grbs_from_csv
        • llama.files.healpix
          • llama.files.healpix.HEALPixSkyMapFileHandler
          • llama.files.healpix.LvcHEALPixSkyMapFileHandler
          • llama.files.healpix.psf
          • llama.files.healpix.skymap
          • llama.files.healpix.utils
        • llama.files.i3
          • llama.files.i3.json
          • llama.files.i3.utils
        • llama.files.lvc_gcn_xml
          • llama.files.lvc_gcn_xml.parse_ivorn
        • llama.files.lvc_skymap
          • llama.files.lvc_skymap.utils
        • llama.files.matlab
          • llama.files.matlab.matlab_eval
      • llama.utils
        • llama.utils.get_voevent_param
        • llama.utils.get_voevent_time
        • llama.utils.parameter_factory
        • llama.utils.rotate_angs2angs
        • llama.utils.rotate_angs2vec
        • llama.utils.write_gzip
        • llama.utils.write_to_zip
  • Source Code Plots

Command Line Interface

  • llama Command Line Interface
    • Named Arguments
    • subcommands (call one with ``–help`` for details on each)
  • llama batch
    • Named Arguments
    • choose pipeline (see ``llama.pipeline``)
    • logging settings
    • simulation configuration
  • llama com
    • Named Arguments
    • subcommands (call one with ``–help`` for details on each)
    • llama com do
      • Named Arguments
    • llama com gracedb
      • Positional Arguments
      • logging settings
    • llama com slack
      • Positional Arguments
      • Named Arguments
      • logging settings
  • llama dev
    • Named Arguments
    • subcommands (call one with ``–help`` for details on each)
    • llama dev background
      • Named Arguments
      • subcommands (call one with ``–help`` for details on each)
      • llama dev background pvalue
        • Named Arguments
      • llama dev background table
        • Positional Arguments
        • Named Arguments
    • llama dev clean
      • Named Arguments
      • filter runs and events (see: ``llama.run``)
      • logging settings
    • llama dev data
      • Named Arguments
      • subcommands (call one with ``–help`` for details on each)
      • llama dev data i3
        • Named Arguments
        • logging settings
    • llama dev docs
      • Named Arguments
      • subcommands (call one with ``–help`` for details on each)
      • llama dev docs cli
        • Positional Arguments
    • llama dev dv
      • Positional Arguments
      • Named Arguments
    • llama dev log
      • Named Arguments
      • subcommands (call one with ``–help`` for details on each)
      • llama dev log lvalert
        • Named Arguments
    • llama dev upload
      • Named Arguments
      • logging settings
  • llama event
    • Positional Arguments
    • choose pipeline (see ``llama.pipeline``)
  • llama files
    • Named Arguments
    • subcommands (call one with ``–help`` for details on each)
    • llama files i3
      • Named Arguments
      • output formats (specify at least 1)
  • llama flags
    • Named Arguments
    • filter runs and events (see: ``llama.run``)
  • llama install
    • Named Arguments
    • logging settings
  • llama listen
    • Named Arguments
    • subcommands (call one with ``–help`` for details on each)
    • llama listen gcn
      • Named Arguments
      • logging settings
    • llama listen lvalert
      • Named Arguments
      • logging settings
  • llama poll
    • Named Arguments
    • subcommands (call one with ``–help`` for details on each)
    • llama poll gracedb
  • llama run
    • Named Arguments
    • choose pipeline (see ``llama.pipeline``)
    • filter runs and events (see: ``llama.run``)
    • logging settings
  • llama serve
    • Named Arguments
    • subcommands (call one with ``–help`` for details on each)
    • llama serve gui
      • Named Arguments
      • logging settings
    • llama serve jupyter
      • Named Arguments
      • logging settings
Low-Latency Algorithm for Multi-messenger Astrophysics (LLAMA)
  • Docs »
  • Performance Profiling »
  • Doctests »
  • llama.com
  • View page source

llama.com¶

  • llama.com.gracedb
    • llama.com.gracedb.GraceDb
Next Previous

© Copyright 2016-2019, Stefan Trklja Countryman, Kenneth Rainer Corley, Doğa Veske

Built with Sphinx using a theme provided by Read the Docs.