cbm_defaults

This package creates a streamlined parameters sqlite database based mostly on the CBM-CFS3 parameters stored in the archive index format (AIDB). The purpose of the streamlined database is to act as a component in the development of next generation models based on CBM-CFS3.

In addition to the default parameters in the AIDB this script will load several other default tables drawn from hardcoded values in the CBM-CFS3 source code among other places.

The database schema supports localization, and it can be configured to load localized strings, such as those found in the CBM-CFS3 model.

Schema

The schema can be viewed in text form here

Example usage

A command line app is included in this repository. The single parameter it uses is the path to a json formatted configuration file. The installed CLI app is named cbm_defaults_export

See: main.py, app.py

cbm_defaults_export --config_path ./config.json

The script can also be called by importing cbm_defaults.app where the single argument is the path to a json formatted file with configuration, or a dictionary containing the configuration.

from cbm_defaults import app
app.run(config)

An example of the configuration format:

    {
        "output_path": "cbm_defaults.db",
        "default_locale": "en-CA",
        "locales": [
            {"id": 1, "code": "en-CA"},
            {"id": 2, "code": "fr-CA"}
        ],
        "archive_index_data": [
            {"locale": "en-CA",
            "path": "ArchiveIndex_Beta_Install.mdb"},
            {"locale": "fr-CA",
            "path": "ArchiveIndex_Beta_Install_fr.mdb"},
        ]
    }

Migrating database version

1.x to 2.x

cbm_defaults has an update utility to migrate version 1.x schema to 2.x. Changes were introduced in April 2023 for land class tracking support, and 1.x versions will not work with newer 2.x versions of libcbm

In python:

from cbm_defaults.update import db_updater
db_updater.update("1x_to_2x", input_db_path, output_db_path)

If cbm_defaults is installed to your python environment, it can be called at the command line with the following:

cbm_defaults_db_update --input_db_path .\cbm_defaults.db --output_db_path  .\cbm_defaults_updated.db