.env.example

# =============================================================================
# SONARIS Environment Configuration
# Copy this file to .env and fill in values for your environment.
# Never commit .env to version control. It is listed in .gitignore.
# =============================================================================


# -----------------------------------------------------------------------------
# General Project Settings
# -----------------------------------------------------------------------------

# Set to "development", "staging", or "production"
APP_ENV=development

# Set to True to enable verbose error output. Always False in production.
APP_DEBUG=True

APP_VERSION=0.1.0


# -----------------------------------------------------------------------------
# Database Configuration
# -----------------------------------------------------------------------------

# SQLite for local development. Switch to postgresql+psycopg2://user:pass@host/db for production.
DATABASE_URL=sqlite:///./sonaris.db

DATABASE_NAME=sonaris_urn_database

# Number of persistent database connections in the pool. Ignored by SQLite.
DB_POOL_SIZE=5


# -----------------------------------------------------------------------------
# Model and Data Paths
# -----------------------------------------------------------------------------

# Absolute or relative paths to raw dataset directories.
SHIPSEAR_DATA_PATH=data/raw/shipsear

QIANDAOEAR_DATA_PATH=data/raw/qiandaoear22

# CSV or JSON files containing digitized audiogram curves per species group.
AUDIOGRAM_DATA_PATH=data/seed/species_audiograms.json

# Path to the saved PyTorch model checkpoint used for URN prediction inference.
TRAINED_MODEL_PATH=models/urn_predictor_v1.pt

# JSON file containing IMO MEPC.1/Circ.906 Rev.1 (2024) URN limits by vessel type and band.
IMO_LIMITS_TABLE_PATH=data/seed/imo_limits.json


# -----------------------------------------------------------------------------
# OpenFOAM Simulation Settings
# -----------------------------------------------------------------------------

# Root installation directory of your OpenFOAM build (v2306 or later).
OPENFOAM_INSTALL_PATH=/opt/openfoam2306

# Directory containing the base OpenFOAM case template used by the physics layer.
OPENFOAM_CASE_TEMPLATE_PATH=sonaris/module2_urn/openfoam_templates/base_case

# Directory where per-run simulation output folders will be written.
SIMULATION_OUTPUT_PATH=data/simulations

# Maximum number of CPU cores to allocate for parallel CFD runs.
MAX_PARALLEL_CORES=4


# -----------------------------------------------------------------------------
# Audio and Acoustic Processing Settings
# -----------------------------------------------------------------------------

# Sampling rate in Hz for all audio loading. ShipsEar recordings vary; librosa resamples to this.
SAMPLE_RATE=22050

# FFT window size in samples. 2048 gives ~93ms frames at 22050 Hz.
N_FFT=2048

# Number of samples between successive FFT frames.
HOP_LENGTH=512

# Number of MFCC coefficients to extract per frame.
N_MFCC=40

# Minimum and maximum frequencies for the acoustic analysis range.
FREQ_MIN_HZ=20
FREQ_MAX_HZ=20000

# 1/3-octave band resolution (fractional octave denominator expressed as a decimal).
OCTAVE_BAND_RESOLUTION=0.333


# -----------------------------------------------------------------------------
# IMO Compliance Settings
# -----------------------------------------------------------------------------

# Document identifier for the IMO guidelines version implemented in Module 3.
IMO_GUIDELINES_VERSION=MEPC.1/Circ.906 Rev.1 (2024)

# Fallback vessel type used when none is specified by the user.
DEFAULT_VESSEL_TYPE=cargo


# -----------------------------------------------------------------------------
# Streamlit UI Settings
# -----------------------------------------------------------------------------

STREAMLIT_PORT=8501

# "light" or "dark". Can be overridden by streamlit config.toml.
STREAMLIT_THEME=light


# -----------------------------------------------------------------------------
# Deployment Settings (Hugging Face Spaces)
# -----------------------------------------------------------------------------

# The name of your Hugging Face Space, e.g. "your-username/sonaris"
HUGGINGFACE_SPACE_NAME=your-username/sonaris

# API token from huggingface.co/settings/tokens. Write access required for deployment.
HUGGINGFACE_TOKEN=hf_your_token_here


# -----------------------------------------------------------------------------
# Logging
# -----------------------------------------------------------------------------

# One of: DEBUG, INFO, WARNING, ERROR
LOG_LEVEL=DEBUG

# Leave blank to log to stdout only. Set a path to write logs to a file as well.
LOG_FILE_PATH=logs/sonaris.log