theta-e.conf

# THETA-E CONFIGURATION FILE
#
# Copyright (c) 2017-18 Jonathan Weyn <jweyn@uw.edu>
#
# See the file LICENSE for your rights.

################################################################################

# General configuration

# Current station ID
current_stid = KSEA

# Root directory of the file hierarchy
THETAE_ROOT =

# Debugging level 0-100
debug = 1

# Tell theta-e to crash with a traceback if an error occurs while processing
# forecast, observation, climo, or verification data.
traceback = 0

# Suppress Python warnings
suppress_warnings = 0

# DO NOT MODIFY
version = 0.2.0

################################################################################

# In this section, place information about the stations.

[Stations]

    [[KSEA]]
        timezone = America/Los_Angeles
        latitude = 47.44472
        longitude = -122.31361
        long_name = "Seattle, Washington"
        history_start = 20180901
        forecast_start = 20180901
        forecast_end = 20180930

    [[KPDX]]
        timezone = America/Los_Angeles
        latitude = 45.58903
        longitude = -122.59346
        long_name = "Portland, Oregon"
        history_start = 20180901
        forecast_start = 20180924
        forecast_end = 20181005

################################################################################

# This section manages the models used for forecasting. Any extra parameters
# needed for specific model sources go here. Each source should have a
# parameter 'historical' which determines whether it is possible to retrieve
# historical forecasts from the source (default False). If a driver needs to
# know which specific model it is using, then construct a parameter that tells
# this to the driver and is specified under the header for each model here that
# uses the driver. For example, both USL12Z and USL22Z will use the same usl
# driver, but should have a parameter 'run_time' that is read by the driver.
# Note that this does not necessarily correspond to the name of the model; that
# name is the subsection header under Models in this conf file.

[Models]

    [[GFS MOS]]
        driver = thetae.data_parsers.mos
        historical = True
        mos_model = GFS
        color = blue

    [[GFS12Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#99bbff'
        run_time = 12Z
        bufr_name = gfs

    [[GFS18Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#1a66ff'
        run_time = 18Z
        bufr_name = gfs

    [[NBS MOS]]
        driver = thetae.data_parsers.mos
        historical = True
        mos_model = NBS
        color = '#0099ff'

    [[NAM MOS]]
        driver = thetae.data_parsers.mos
        historical = True
        mos_model = NAM
        color = green

    [[NAM12Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#66ff66'
        run_time = 12Z
        bufr_name = nam

    [[NAM18Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#00e600'
        run_time = 18Z
        bufr_name = nam

    [[NAMNEST12Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#79d2a6'
        run_time = 12Z
        bufr_name = nam3km

    [[NAMNEST18Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#339966'
        run_time = 18Z
        bufr_name = nam3km

    [[HRRR12Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#ff0000'
        run_time = 12Z
        bufr_name = hrrr

    [[HRRR18Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#800000'
        run_time = 18Z
        bufr_name = hrrr

    [[RAP12Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#bf4040'
        run_time = 12Z
        bufr_name = rap

    [[RAP18Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#602020'
        run_time = 18Z
        bufr_name = rap

    [[FV312Z]]
        driver = thetae.data_parsers.bufkit
        historical = False
        color = '#4040bf'
        run_time = 12Z
        bufr_name = fv3gfsx

    [[NWS]]
        driver = thetae.data_parsers.nws
        historical = False
        color = darkgrey

    [[UKMET]]
        driver = thetae.data_parsers.ukmet
        historical = False
        api_id = 
        api_secret = 
        color = '#9966ff'

    [[DARKSKY]]
        driver = thetae.data_parsers.darksky
        historical = False
        api_key = 
        color = lightslategrey

    [[ACCUWX]]
        driver = thetae.data_parsers.accuweather
        historical = False
        api_key = 
        color = '#cccccc'

    [[WU/TWC]]
        driver = thetae.data_parsers.twc
        historical = False
        api_key = 
        color = darkorange

    [[AERIS]]
        driver = thetae.data_parsers.aeris
        historical = False
        api_id = 
        api_secret = 
        color = burlywood

    [[OWM]]
        driver = thetae.data_parsers.openweathermap
        historical = False
        api_key = 
        color = '#FF00FF'

    [[CLIMA]]
        driver = thetae.data_parsers.climacell
        historical = False
        api_key =
        color = '#43a6ef'

    [[YRNO]]
        driver = thetae.data_parsers.yrno
        historical = False
        color = '#E9967A'

    [[USL12Z]]
        driver = thetae.data_parsers.usl
        historical = False
        run_time = 12Z
        color = gold

    [[USL22Z]]
        driver = thetae.data_parsers.usl
        historical = False
        run_time = 22Z
        color = gold
        
    [[WRF4KM]]
        driver = thetae.data_parsers.bufkit
        historical = False
        run_time = 12Z
        color = magenta
        bufr_name = wrfd3

    [[WRF1KM]]
        driver = thetae.data_parsers.bufkit
        historical = False
        run_time = 12Z
        color = hotpink
        bufr_name = wrfd4

    [[MOS-X]]
        driver = thetae.data_parsers.mosx
        historical = True
        file_dir = %(THETAE_ROOT)s/../MOS-X
        color = purple

################################################################################

# This section determines the modules used for verification retrieval. This
# should probably not be changed unless new modules are used in the future for
# better retrieval and/or processing of verification data.

[Verify]

    # API key for MesoWest
    api_key =
    # Refresh interval for obs and verification. For best efficiency, set to 24
    # hours or more. The current_stid will always refresh regardless of this.
    obs_refresh_interval_hours = 24

    # The daily verification
    [[Verification]]
        driver = thetae.verify.verification

    # The hourly observations
    [[Obs]]
        driver = thetae.verify.obs

    # Climatology
    [[Climo]]
        driver = thetae.verify.climo

################################################################################

# This section is for the main theta-e engine. It defines the services that
# fetch the data, output plots and web data, and so on.

[Engine]

    [[Services]]
        # Grouped by types of services. The order is the order in which they
        # will run. This leaves the option of other services in the
        # "user" folder to be easily added
        retrieve_services = thetae.getForecasts, thetae.getVerification,
        calc_services = thetae.calcVerification,
        output_services = thetae.plot.all, thetae.web.all,

################################################################################

# This section does the database binding. The main database is 'forecast', and
# the parameters govern how the database is connected to an actual SQL file.

[DataBinding]

    # This is the main theta-e forecast database configuration. It should
    # probably not be changed.
    [[forecast]]
        # The database must match one of the sections in [Databases].
        database = fcst_archive
        # The schema defines the structure of the timeseries and daily tables.
        schema = thetae.schemas.default

################################################################################

# This section defines the databases. Secondary databases may be used in the 
# future for novel purposes.

[Databases]

    # A SQLite database for general forecast archiving
    [[fcst_archive]]
        # Only SQLite is available for now
        database_type = SQLite
        database_name = theta-e.sdb

################################################################################

# This section provides options for BUFKIT models which use the BUFRgruven
# command-line program. This is only available for Linux OS.

[BUFKIT]

    # Full path to the BUFRgruven executable
    BUFR =

    # Directory in which to write BUFKIT files
    BUFKIT_directory =

    # Optionally archive BUFKIT files
    archive = False

################################################################################

# This section provides options for the plot module.

[Plot]

    # List here all plots to be executed by thetae.plot.all. Each should be an
    # individual attribute of the thetae.plot module.
    plots = timeseries, timeheight, modelwinds, climo,

    # Any additional configuration options read by any of the plot functions
    # should go here.
    [[Options]]
        plot_all_stations = False
        plot_file_format = svg
        plot_directory = %(THETAE_ROOT)s/site_data/plots
        variables = temperature, dewPoint, windSpeed, rain,

################################################################################

# This section provides options for the web module.

[Web]

    # List here all plots to be executed by thetae.plot.all. Each should be an
    # individual attribute of the thetae.plot module.
    outputs = web_json, stats, settings,

    # Settings for the web configuration go here. For now, only local server
    # directories are supported.
    [[Settings]]
        # This is the local server directory where all web output is written to
        web_directory = %(THETAE_ROOT)s/site_data
        # Root URL for the website, i.e., https://www.example.com
        page_url = .
        # Path on the website, i.e., 'theta-e' for https://www.example.com/theta-e
        page_path = .
        # Location of json files relative to website root + path
        json_directory = ./json
        # Location of plot files relative to website root + path. Corresponds
        # to plot Options plot_directory above.
        plot_directory = ./plots

    # Any additional configuration options read by any of the web functions
    # should go here.
    [[Options]]
        output_all_stations = False

################################################################################