Installation Guide¶

This guide covers installation of almanac in various environments.

Requirements¶

Python: 3.8 or higher
System Requirements: Access to raw APOGEE data frames (local disk or mounted filesystem)
Database Access: SDSS database access (automatic at Utah, requires whitelisting elsewhere)

The simplest installation method if you’re working at Utah:

module load almanac

Setting up Python Environment at Utah (if needed):

module load miniconda/3.8.5_astra

Install using uv for dependency management:

uv pip install git+https://github.com/sdss/almanac

Standard pip installation:

pip install git+https://github.com/sdss/almanac

For development work:

git clone https://github.com/sdss/almanac.git
cd almanac
uv pip install -e ".[dev]"

If installing outside Utah, you’ll need to:

Get database access: Ensure your IP address is whitelisted for SDSS database access
Configure connection: Use almanac config to set database parameters if needed

almanac config show  # View current configuration
almanac config set sdssdb.host your-host-address

Outside Utah: Set up Globus transfer for raw APOGEE data frames to ensure local disk access.

Verify installation:

almanac --help
almanac config show

Test basic functionality:

almanac --mjd -1  # Query yesterday's observations

Core dependencies are automatically installed:

Development dependencies (with [dev] install):

Database Connection Timeout:

Missing Raw Data:

Permission Issues: