Skip to main content

NEMS configuration generation

Project description

NEMSpy

tests build version oitnb license

NEMSpy generates configuration files (nems.configure, config.rc, model_configure, atm_namelist.rc) for coupled modeling applications run with a compiled NEMS binary (not included).

NEMS implements the National Unified Operational Prediction Capability (NUOPC), and configuration files built for NEMS will also work for most NUOPC applications.

Usage:

from datetime import datetime, timedelta

from nemspy import ModelingSystem
from nemspy.model import (
    ADCIRCEntry,
    AtmosphericMeshEntry,
    WaveMeshEntry,
)

# model run time
start_time = datetime(2020, 6, 1)
duration = timedelta(days=1)

# returning interval of main run sequence
interval = timedelta(hours=1)

# directory to which configuration files should be written
output_directory = '~/nems_configuration/'

# model entries
ocean_model = ADCIRCEntry(processors=11, verbose=True, DumpFields=False)
atmospheric_mesh = AtmosphericMeshEntry('~/wind_atm_fin_ch_time_vec.nc')
wave_mesh = WaveMeshEntry('~/ww3.Constant.20151214_sxy_ike_date.nc')

# instantiate model system with model entries
nems = ModelingSystem(
    start_time, duration, interval, ocn=ocean_model, atm=atmospheric_mesh, wav=wave_mesh,
)

# form connections between models
nems.connect('ATM', 'OCN')
nems.connect('WAV', 'OCN')

# define execution order
nems.sequence = [
    'ATM -> OCN',
    'WAV -> OCN',
    'ATM',
    'WAV',
    'OCN',
]

# write configuration files to the given directory
nems.write(output_directory, overwrite=True, include_version=True)

Output:

nems.configure

# `nems.configure` generated with NEMSpy 0.4.4
# EARTH #
EARTH_component_list: ATM WAV OCN
EARTH_attributes::
  Verbosity = min
::

# ATM #
ATM_model:                      atmesh
ATM_petlist_bounds:             0 0
ATM_attributes::
  Verbosity = min
::

# WAV #
WAV_model:                      ww3data
WAV_petlist_bounds:             1 1
WAV_attributes::
  Verbosity = min
::

# OCN #
OCN_model:                      adcirc
OCN_petlist_bounds:             2 12
OCN_attributes::
  Verbosity = max
  DumpFields = false
::

# Run Sequence #
runSeq::
  @3600
    ATM -> OCN   :remapMethod=redist
    WAV -> OCN   :remapMethod=redist
    ATM
    WAV
    OCN
  @
::

config.rc

# `config.rc` generated with NEMSpy 0.4.4
 atm_dir: ~
 atm_nam: wind_atm_fin_ch_time_vec.nc
 wav_dir: ~
 wav_nam: ww3.Constant.20151214_sxy_ike_date.nc

model_configure

# `model_configure` generated with NEMSpy 0.4.4
total_member:            1
print_esmf:              .true.
namelist:                atm_namelist
PE_MEMBER01:             13
start_year:              2020
start_month:             6
start_day:               1
start_hour:              0
start_minute:            0
start_second:            0
nhours_fcst:             24
RUN_CONTINUE:            .false.
ENS_SPS:                 .false.

Related:

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nemspy-0.4.7.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

nemspy-0.4.7-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file nemspy-0.4.7.tar.gz.

File metadata

  • Download URL: nemspy-0.4.7.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

File hashes

Hashes for nemspy-0.4.7.tar.gz
Algorithm Hash digest
SHA256 e90bcd36b89946a696c5fa25d325df4ac7823db457e2f02a174633f8f319b8a3
MD5 784d09edff0b44bf0d2c0c85a3ad6d3c
BLAKE2b-256 198f5634011355a2192d42be823f4279b854494abae1ef0074126ce359372f43

See more details on using hashes here.

Provenance

File details

Details for the file nemspy-0.4.7-py3-none-any.whl.

File metadata

  • Download URL: nemspy-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0

File hashes

Hashes for nemspy-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c415f73d645e3efe38c1ee58c9f1462508cfca2c91741a095f56949cf24fa2fc
MD5 7482758a17c5492d53af9bfc1bea03d1
BLAKE2b-256 04928fc4f4f440433dc57d0dab8dbcf7639dd7ffff8b070a138e5cf4ac96711a

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page