User Guide

This guide is intended to be used as an overview for Scarabaeus. It begins with a guide to set up and install the tool, as well as details on how to access necessary data through the data base. Additional supporting libraries and their uses, as well as a general walkthrough of the orbit determination process and how it functions within Scarabaeus are also spoken on.

See the API Reference for details on specific classes and/or functions.

Getting Started

• Install and Set Up Scarabaeus
  • Prerequisites
    • Python
    • Git
    • Integrated Development Environment (IDE)
  • Clone Scarabaeus Repository
  • Add Scarabaeus Package to Python Path
  • Creating a Virtual Environment
    • From Terminal
    • In VSC
  • Library Installation
    • From Terminal
    • In VSC
    • External
• MongoDB Installation and Setup
  • Introduction
  • Windows
  • macOS
    • Prerequisites
    • Install Xcode Command-Line Tools
    • Install Homebrew
  • Setup LASP Credentials to Access MongoDB
    • Windows
    • macOS/Linux

Scarabaeus Data Flow and Processes

• The Orbit Determination Process
• Data Flow

Miscellaneous

• Libraries
  • Geometry and Ephemeris
  • Integration
  • Math
  • Plotting
  • Integrated Tests and Documentation
  • Database
  • Others from ORCCA
  • External Software