Skip to main content
Follow these steps to integrate a new weather model into ModMS:
1

Add to Aggregator

Configure the model in the Aggregator to download according to schedule.
The Aggregator configuration determines when and how often the model data is downloaded.
2

Whitelist in Indexer

Ensure the model is whitelisted in the Indexer configuration.
If the model is not whitelisted, the Indexer will skip processing its files.
3

Define Variables

Make sure variables are properly defined in grib[12].csv files with correct naming conventions.Variable Naming Requirements:
  • Variable names must be consistent across all model runs
  • Names should follow the standard meteorological variable conventions
  • Special characters should be avoided
  • Case sensitivity matters
4

Verify GRIB Templates

Ensure the Indexer can properly decode the GRIB templates for the new model format.
Different models may use different GRIB template versions. Verify compatibility before deployment.

Important Considerations

Variable naming is critical for API queries. Inconsistent naming will cause query failures.
  • Use standard meteorological variable names
  • Maintain consistency across model versions
  • Document any custom variable names
Coordinate the download schedule with the model’s update frequency to avoid missing data or unnecessary downloads.
Consider the storage impact of adding a new model, especially for high-resolution or frequently-updated models.

Testing

After adding a new model:
  1. Verify the Aggregator successfully downloads the model data
  2. Check that the Indexer processes the files correctly
  3. Confirm variables are accessible through the Server API
  4. Test queries to ensure data integrity