Skip to content

Detect AWS and Mac platforms, and automatically set platform #545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mranst wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Detect AWS and Mac platforms, and automatically set platform #545

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
da08140
Add platform detection for AWS and Mac
mranst May 7, 2025
4a95a8c
Automatically set platform based on host
mranst May 7, 2025
48ac7c7
Fix for CI tests
mranst May 7, 2025
d992c1c
bugfix for cylc
mranst May 8, 2025
d338dd3
Raise errors for unsupported platforms
mranst May 8, 2025
072d785
Add support for cylc on AWS
mranst May 8, 2025
692798a
fix detection
mranst May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/swell/cylc_swell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import os
import sys

from swell.deployment.platforms.platforms import SwellPlatform
from swell.deployment.platforms.platforms import SwellPlatforms
from swell.utilities.logger import Logger

# --------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -58,7 +58,7 @@ def execute_cylc(argv=sys.argv) -> None:
platform = SwellPlatform.detect_platform()

# Location for Discover cylc installation
if platform in [SwellPlatform.NCCS_DISCOVER_CASCADE, SwellPlatform.NCCS_DISCOVER_SLES15]:
if platform in [SwellPlatforms.NCCS_DISCOVER_CASCADE, SwellPlatforms.NCCS_DISCOVER_SLES15]:
opt = '/discover/nobackup/projects/gmao/advda/swell/dev/core/cylc/sles15_8.4.0/'
python_ver = 'python3.11'

Expand Down
88 changes: 51 additions & 37 deletions src/swell/deployment/platforms/platforms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import yaml
from enum import Enum
import subprocess
import platform as pltfrm
from typing import Self

from importlib import resources

Expand All @@ -30,22 +32,6 @@ def platform_path() -> str:
# --------------------------------------------------------------------------------------------------


def get_platforms() -> list:

# Get list of supported platforms
platforms = [dir for dir in os.listdir(platform_path())
if os.path.isdir(os.path.join(platform_path(), dir))]

# If anything in platforms contains '__' remove it from platforms list
platforms = [platform for platform in platforms if '__' not in platform]

# List all directories in directory
return platforms


# --------------------------------------------------------------------------------------------------


def login_or_compute(platform) -> str:

'''
Expand Down Expand Up @@ -87,36 +73,64 @@ def login_or_compute(platform) -> str:
# --------------------------------------------------------------------------------------------------


class SwellPlatform(Enum):
''' Store filepaths for platform defaults. '''
NCCS_DISCOVER_SLES15 = os.path.join(platform_path(), 'nccs_discover_sles15')
NCCS_DISCOVER_CASCADE = os.path.join(platform_path(), 'nccs_discover')
GENERIC = os.path.join(platform_path(), 'generic')
class SwellPlatforms(Enum):
''' Track platforms supported by Swell. '''
NCCS_DISCOVER_SLES15 = 'nccs_discover_sles15'
NCCS_DISCOVER_CASCADE = 'nccs_discover_cascade'
AWS = 'aws'
MAC = 'mac'
GENERIC = 'generic'

@classmethod
def detect_platform(cls):
''' Detect the current platform, or return generic (NCCS only). '''
''' Detect the current platform, or return generic. '''

# Try to get the hostname
hostname = os.environ.get('HOSTNAME')
if hostname is None or not any(key in hostname for key in ['discover', 'borg', 'warp']):
return cls.GENERIC
os_name = pltfrm.platform()

if hostname is not None:

# Check for Discover hostnames
if any(key in hostname for key in ['discover', 'borg', 'warp']):

# Try the lscpu shell command, which should be available across NCCS
try:
cpu_info = str(subprocess.run('lscpu', capture_output=True).stdout)
try:

@ashiklom ashiklom May 8, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure Swell won't actually work with the GENERIC platform, right? If that's the case, I suggest we don't actually include it as a "supported" platform here and just let any errors in this section get thrown (which would be a noteworthy error --- we're already limiting this section to Discover hostnames).

@ashiklom ashiklom May 8, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or would this break code_tests or other unit tests running on a generic linux machine or something? I.e., Does code_tests depend on the platform? If so, it shouldn't!

@mranst mranst May 8, 2025

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code tests don't depend on platform, but one quirk of the click interface is that it executes all calls in the driver group regardless of whether the particular command that needs it is called or not. So if we raise an error if the platform was not detected, it will raise that error any time swell is called for any purpose

@ashiklom ashiklom May 8, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, makes sense. Can we work around that with something like this?

@swell_driver.command()
@click.argument('suite', type=click.Choice(AllSuites.config_names()))
@click.option('-m', '--input_method', 'input_method', default='defaults',
              type=click.Choice(['defaults', 'cli']), help=input_method_help)
@click.option('-p', '--platform', 'platform', default=None,     # <--- NOTE: Default to `None`
              type=click.Choice(platforms.get_all()), help=platform_help)
@click.option('-o', '--override', 'override', default=None, help=override_help)
@click.option('-a', '--advanced', 'advanced', default=False, help=advanced_help)
@click.option('-s', '--slurm', 'slurm', default=None, help=slurm_help)
def create(
    suite: str,
    input_method: str,
    platform: str | None,
    override: Union[dict, str, None],
    advanced: bool,
    slurm: str
) -> None:
    """
    Create a new experiment

    This command creates an experiment directory based on the provided suite name and options.

    Arguments: \n
        suite (str): Name of the suite you wish to run. \n

    """

    if platform is None:
        platform = platforms.detect_platform()

    # Create the experiment directory
    create_experiment_directory(suite, input_method, platform, override, advanced, slurm)

# Try the lscpu shell command, which should be available across NCCS
cpu_info = str(subprocess.run('lscpu', capture_output=True).stdout)

model_name = cpu_info.split('Model name:')[1].strip().split('\n')[0].strip()
model_name = cpu_info.split('Model name:')[1].strip().split('\n')[0].strip()

# Match the cpu to the expected platform
if all(key in model_name for key in ['Intel', 'Xeon']):
return cls.NCCS_DISCOVER_CASCADE
elif all(key in model_name for key in ['AMD', 'EPYC']):
return cls.NCCS_DISCOVER_SLES15
else:
return cls.GENERIC
# Match the cpu to the expected platform
if all(key in model_name for key in ['Intel', 'Xeon']):
return cls.NCCS_DISCOVER_CASCADE
elif all(key in model_name for key in ['AMD', 'EPYC']):
return cls.NCCS_DISCOVER_SLES15

@ashiklom ashiklom May 8, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If neither of these conditions is met, suggest raising a ValueError(f"Unknown CPU architecture: {model_name}").


except (FileNotFoundError, IndexError):
return cls.GENERIC

# Check for AWS
if all(key in os_name for key in ['Linux', 'aws']):
return cls.AWS

# Check for Mac
if all(key in os_name for key in ['macOS', 'arm64']):
return cls.MAC

return cls.GENERIC

@ashiklom ashiklom May 8, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per my comment above. If we've gotten this far, I suggest we just throw an error.

raise ValueError(f"Unknown or unsupported platform: {os_name}")


# --------------------------------------------------------------------------------------------------

@classmethod
def get_all(cls) -> list:
return [item.value for item in cls]

# --------------------------------------------------------------------------------------------------

@classmethod
def match_name(cls, name: str) -> Self:
# Return the enum instance based on the name
return getattr(cls, name.upper())

except (FileNotFoundError, IndexError):
return cls.GENERIC

# --------------------------------------------------------------------------------------------------
17 changes: 9 additions & 8 deletions src/swell/swell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import click
from typing import Union, Optional, Literal

from swell.deployment.platforms.platforms import get_platforms
from swell.deployment.platforms.platforms import SwellPlatforms as platforms
from swell.deployment.create_experiment import clone_config, create_experiment_directory
from swell.deployment.launch_experiment import launch_experiment
from swell.tasks.base.task_base import task_wrapper, get_tasks
Expand Down Expand Up @@ -55,7 +55,7 @@ def swell_driver() -> None:

platform_help = 'If using defaults for input_method, this option is used to determine which ' + \
'platform to use for platform specific defaults. Options are ' + \
str(get_platforms())
str(platforms.get_all())

override_help = 'After generating the config file, parameters inside can be overridden ' + \
'using values from the override config file.'
Expand Down Expand Up @@ -90,8 +90,8 @@ def swell_driver() -> None:
@click.argument('suite', type=click.Choice(AllSuites.config_names()))
@click.option('-m', '--input_method', 'input_method', default='defaults',
type=click.Choice(['defaults', 'cli']), help=input_method_help)
@click.option('-p', '--platform', 'platform', default='nccs_discover_sles15',
type=click.Choice(get_platforms()), help=platform_help)
@click.option('-p', '--platform', 'platform', default=platforms.detect_platform().value,
type=click.Choice(platforms.get_all()), help=platform_help)
@click.option('-o', '--override', 'override', default=None, help=override_help)
@click.option('-a', '--advanced', 'advanced', default=False, help=advanced_help)
@click.option('-s', '--slurm', 'slurm', default=None, help=slurm_help)
Expand All @@ -112,6 +112,7 @@ def create(
suite (str): Name of the suite you wish to run. \n

"""

# Create the experiment directory
create_experiment_directory(suite, input_method, platform, override, advanced, slurm)

Expand Down Expand Up @@ -244,8 +245,8 @@ def test(test: str) -> None:


@swell_driver.command()
@click.option('-p', '--platform', 'platform', type=click.Choice(get_platforms()),
default="nccs_discover_sles15", help=platform_help)
@click.option('-p', '--platform', 'platform', type=click.Choice(platforms.get_all()),
default=platforms.detect_platform().value, help=platform_help)
@click.argument('suite', type=click.Choice(("hofx", "3dvar", "ufo_testing")))
def t1test(
suite: Literal["hofx", "3dvar", "ufo_testing"],
Expand All @@ -264,8 +265,8 @@ def t1test(


@swell_driver.command()
@click.option('-p', '--platform', 'platform', type=click.Choice(get_platforms()),
default="nccs_discover_sles15", help=platform_help)
@click.option('-p', '--platform', 'platform', type=click.Choice(platforms.get_all()),
default=platforms.detect_platform().value, help=platform_help)
@click.argument('suite', type=click.Choice(("hofx", "3dvar", "ufo_testing",
"convert_ncdiags", "3dfgat_atmos", "build_jedi")))
def t2test(
Expand Down