NEMS configuration generation

Project description

NEMSpy

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)
end_time = start_time + duration

# 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,
    Verbosity='max',
    DumpFields=False
)
atmospheric_mesh = AtmosphericMeshEntry(
    filename='~/wind_atm_fin_ch_time_vec.nc',
    processors=1
)
wave_mesh = WaveMeshEntry(
    filename='~/ww3.Constant.20151214_sxy_ike_date.nc',
    processors=1
)

# instantiate model system with model entries
nems = ModelingSystem(
    start_time=start_time,
    end_time=end_time,
    interval=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(
    directory=output_directory,
    overwrite=True,
    include_version=True
)

Output:

nems.configure

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

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

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

# 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
  @
::

model_configure

# `model_configure` generated with NEMSpy 0.5.0
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.

config.rc

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

Project details

Release history Release notifications | RSS feed

1.0.8

Mar 29, 2022

1.0.7

Mar 3, 2022

1.0.6

Mar 2, 2022

1.0.5

Dec 28, 2021

1.0.4

Nov 17, 2021

1.0.3

Aug 4, 2021

1.0.2

Jul 23, 2021

1.0.1

Jul 8, 2021

1.0.0

Jul 2, 2021

0.6.21

Jul 2, 2021

0.6.20

Jun 30, 2021

0.6.19

Jun 30, 2021

0.6.18

Jun 29, 2021

0.6.17

Jun 22, 2021

0.6.16

Apr 28, 2021

0.6.15

Apr 28, 2021

0.6.14

Apr 16, 2021

0.6.13

Apr 6, 2021

0.6.12

Mar 30, 2021

0.6.11

Mar 29, 2021

0.6.10

Mar 26, 2021

This version

0.6.9

Mar 22, 2021

0.6.8

Mar 19, 2021

0.6.7

Mar 19, 2021

0.6.6

Mar 8, 2021

0.6.5

Mar 8, 2021

0.6.4

Mar 8, 2021

0.6.3

Feb 12, 2021

0.6.2

Feb 2, 2021

0.6.1

Jan 29, 2021

0.6.0

Jan 29, 2021

0.5.9a0 pre-release

Jan 26, 2021

0.5.8

Jan 11, 2021

0.5.7

Jan 6, 2021

0.5.6

Nov 6, 2020

0.5.5

Nov 5, 2020

0.5.4

Nov 2, 2020

0.5.3

Oct 29, 2020

0.5.2

Oct 27, 2020

0.5.1

Oct 26, 2020

0.5.0

Oct 26, 2020

0.4.7

Oct 22, 2020

0.4.6

Oct 15, 2020

0.4.5

Oct 14, 2020

0.4.4

Oct 14, 2020

0.4.3

Oct 6, 2020

0.4.2

Oct 5, 2020

0.4.1

Oct 5, 2020

0.4.0

Oct 2, 2020

0.3.3

Oct 2, 2020

0.3.2

Sep 28, 2020

0.3.1

Sep 24, 2020

0.3.1a0 pre-release

Sep 24, 2020

0.3.0

Sep 24, 2020

0.2.5

Sep 23, 2020

0.2.4

Sep 22, 2020

0.2.3

Sep 22, 2020

0.2.2

Sep 17, 2020

0.2.1

Sep 17, 2020

0.2.0

Sep 17, 2020

0.1.7

Sep 16, 2020

0.1.6

Sep 16, 2020

0.1.5

Sep 16, 2020

0.1.5a0 pre-release

Sep 16, 2020

0.1.4

Sep 16, 2020

0.1.3

Sep 16, 2020

0.1.3a0 pre-release

Sep 16, 2020

0.1.2 yanked

Sep 16, 2020

Reason this release was yanked:

testing

0.1.1

Sep 16, 2020

0.1.0

Sep 16, 2020

0.0.1 yanked

Sep 16, 2020

Reason this release was yanked:

testing

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.6.9.tar.gz (14.3 kB view details)

Uploaded Mar 22, 2021 Source

Built Distribution

nemspy-0.6.9-py3-none-any.whl (18.6 kB view details)

Uploaded Mar 22, 2021 Python 3

File details

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

File metadata

Download URL: nemspy-0.6.9.tar.gz
Upload date: Mar 22, 2021
Size: 14.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for nemspy-0.6.9.tar.gz
Algorithm	Hash digest
SHA256	`c607b17aae5a5557b5fb153ce03e0a76542e41a277e178fbc1c59b1fb95e2e2d`
MD5	`73aa1a7759481a1d89e7135e7b52006b`
BLAKE2b-256	`947393cdafedbe158c32f191b591a8595cb72db670fbc59245e4484f39350ad3`

See more details on using hashes here.

Provenance

File details

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

File metadata

Download URL: nemspy-0.6.9-py3-none-any.whl
Upload date: Mar 22, 2021
Size: 18.6 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for nemspy-0.6.9-py3-none-any.whl
Algorithm	Hash digest
SHA256	`88fa06e407ca87b4c08b638be327af80ee08708d06947f50ab3f1fefadb210d4`
MD5	`03da109c0a58a35c3dcd8c74a36a77c6`
BLAKE2b-256	`c50431c1ecbc65d78898a2267c1ad5dae18375c59987819c090f3f59a8124604`