Skip to content

SURF Configuration File

The SURF configuration file is your single entry point for configuring an experiment. It is used by SURF to orchestrate all the various phases of the experiment workflow.

Note

The SURF configuration file is distinct from the SHYFEM-MPI configuration file. It defines user-defined parameters that control the overall downscaling experiment workflow. Some of these parameters are used to populate the SHYFEM-MPI configuration files, which contain the full set of parameters required by the SHYFEM-MPI ocean model. For more information, please refer to the Shyfem Configuration section.

The SURF configuration file is based on the JavaScript Object Notation (JSON) format, a simple, text-based method for storing and transmitting structured data. You can open JSON files with your favorite text editor, and adapt the parameter values to your needs.

Depending on your experience level or case study requirements, you can choose between:

The Base Configuration File

The Base configuration file contains the minimal set of parameters required to run a SURF experiment. Several aspects of the model setup — such as physical parameterization and numerical schemes — are predefined and cannot be modified by users.

If you have run the Madagascar case study with automated data download, you have already encountered the Base configuration file (you should find it under $SURF_SHYFEM_DIR/configurations/config_base_bay_madagascar.json on your local machine).

Here you can explore the Base configuration file and learn more about the available parameters:

config_base_bay_madagascar.json

Loading...

The Expert Configuration File

The Expert configuration file is designed for advanced users who require detailed control over their experiment settings. It enables extensive customization, including modifications to the physical parametrizations used by SHYFEM-MPI.

If you have run the Madagascar case study with local data, you have already encountered the Expert configuration file (you should find it under $SURF_SHYFEM_DIR/configurations/config_expert_bay_madagascar.json on your local machine)

Here you can explore an example Expert configuration file for the Madagascar case study and learn more about the available parameters:

config_expert_bay_madagascar.json

Loading...