conftest.py

import pytest
from wrfhydropy import *


def pytest_addoption(parser):

    # Required args:

    parser.addoption(
        '--domain_dir',
        required=True,
        action='store',
        help='domain directory'
    )

    parser.addoption(
        '--output_dir',
        required=True,
        action='store',
        help='test output directory'
    )

    parser.addoption(
        '--candidate_dir',
        required=True,
        action='store',
        help='candidate model directory'
    )

    parser.addoption(
        '--reference_dir',
        required=True,
        action='store',
        help='reference model directory'
    )

    # Optional args:
    parser.addoption(
        "--config",
        required=True,
        action='store',
        help=("List of model configurations to test, options include all configs listed in "
              "hydro_namelist.json keys")
    )

    parser.addoption(
        '--compiler',
        default='gfort',
        required=False,
        action='store',
        help='compiler, options are intel or gfort'
    )

    parser.addoption(
        '--ncores',
        default='2',
        required=False,
        action='store',
        help='Number of cores to use for testing'
    )

    parser.addoption(
        '--scheduler',
        default=None,
        required=False,
        action='store',
        help='Scheduler to use for testing, options are PBSCheyenne or do not specify for no '
             'scheduler')

    parser.addoption(
        '--nnodes',
        default='2',
        required=False,
        action='store',
        help='Number of nodes to use for testing if running on scheduler'
    )
    parser.addoption(
        '--account',
        default='NRAL0017',
        required=False,
        action='store',
        help='Account number to use if using a scheduler.')

def _make_sim(domain_dir,
              source_dir,
              configuration,
              ncores,
              nnodes,
              scheduler,
              account):
    # model
    model = Model(
        source_dir=source_dir,
        model_config=configuration
    )

    # domain
    domain = Domain(
        domain_top_dir=domain_dir,
        domain_config=configuration)

    # Job
    exe_command = ('mpirun -np {0} ./wrf_hydro.exe').format(str(ncores))
    job = Job(job_id='test_job',exe_cmd=exe_command)

    # simulation
    sim = Simulation()
    sim.add(model)
    sim.add(domain)
    sim.add(job)

    if scheduler is not None and scheduler == 'pbscheyenne':
        sim.add(schedulers.PBSCheyenne(account=account,nproc=int(ncores),nnodes = int(nnodes)))

    if configuration == 'nwm_channel-only':
        # Update the forcing here to be taken from the nwm_ana run dir
        sim.domain

    return sim

@pytest.fixture(scope="session")
def candidate_sim(request):

    domain_dir = request.config.getoption("--domain_dir")
    candidate_dir = request.config.getoption("--candidate_dir")
    configuration = request.config.getoption("--config")
    ncores = request.config.getoption("--ncores")
    nnodes = request.config.getoption("--nnodes")
    scheduler = str(request.config.getoption("--scheduler")).lower()
    account = request.config.getoption("--account")

    candidate_sim = _make_sim(domain_dir = domain_dir,
                              source_dir= candidate_dir,
                              configuration=configuration,
                              ncores = ncores,
                              nnodes = nnodes,
                              scheduler = scheduler,
                              account = account)

    return candidate_sim

@pytest.fixture(scope="session")
def reference_sim(request):

    domain_dir = request.config.getoption("--domain_dir")
    reference_dir = request.config.getoption("--reference_dir")
    configuration = request.config.getoption("--config")
    ncores = request.config.getoption("--ncores")
    nnodes = request.config.getoption("--nnodes")
    scheduler = str(request.config.getoption("--scheduler")).lower()
    account = request.config.getoption("--account")

    reference_sim = _make_sim(domain_dir = domain_dir,
                              source_dir= reference_dir,
                              configuration=configuration,
                              ncores = ncores,
                              nnodes = nnodes,
                              scheduler = scheduler,
                              account = account)

    return reference_sim

@pytest.fixture(scope="session")
def output_dir(request):
    configuration = request.config.getoption("--config")
    output_dir = request.config.getoption("--output_dir")

    output_dir = pathlib.Path(output_dir)
    output_dir = output_dir / configuration

    if output_dir.is_dir() is True:
        shutil.rmtree(str(output_dir))

    output_dir.mkdir(parents=True)
    return output_dir