User Guide

The User Guide will provide examples showing how to use FREDpy. It will be developed more fully once we have settled on common usage patterns and developed the code base.

The following sections need to be added here:

• Installation

• User Guide

In the meantime, the following sections are currently available.

• Getting Started with fredcli
  • Preparing to Install
    • Hardware Requirements
    • Installation Prerequisites
    • Configuring the FRED_API_KEY environment variable
  • Installing fredcli
  • Configuring fredcli
    • Getting an Access Token
    • Storing the Access Token
  • Running a FRED model
    • Download a Sample Model
    • Run a Sample Model
  • Next Steps
• Batch Configuration Files
  • Batch Labels
  • Synthetic Population Data
  • Model Dependencies
    • GitHub Repository Dependencies
    • Data Dependencies
  • Environment Settings
  • Work Items
    • Script Work Items
    • Job Work Items
  • Sample Configuration File
• Batch Execution Scripts