Raise informative error when on unsupported system (#1126)

* Raise informative error when on unsupported system

Signed-off-by: James Bourbeau <[email protected]>

* Retrigger CI

Signed-off-by: James Bourbeau <[email protected]>

---------

Signed-off-by: James Bourbeau <[email protected]>
Co-authored-by: Ayush Dattagupta <[email protected]>

Author: jrbourbeau

nemo_curator/__init__.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import os
+import sys
 
 from .package_info import (
     __contact_emails__,
@@ -35,3 +36,13 @@
 # We set these incase a user ever starts a ray cluster with nemo_curator, we need these for Xenna to work
 os.environ["RAY_MAX_LIMIT_FROM_API_SERVER"] = str(API_LIMIT)
 os.environ["RAY_MAX_LIMIT_FROM_DATA_SOURCE"] = str(API_LIMIT)
+
+# Raise an informative error early to users on unsupported systems
+if sys.platform != "linux":
+    _msg = (
+        "NeMo-Curator currently only supports Linux systems, "
+        f"while the current machine has a {sys.platform} system. \n"
+        "For more information on installation and system requirements, see "
+        "https://docs.nvidia.com/nemo/curator/latest/admin/installation.html"
+    )
+    raise ValueError(_msg)

tests/test___init__.py

@@ -0,0 +1,28 @@
+# Copyright (c) 2025, NVIDIA CORPORATION.  All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import sys
+
+import pytest
+
+
+def test_raises_system_error(monkeypatch: pytest.MonkeyPatch):
+    monkeypatch.setattr(sys, "modules", {})
+    dummy_platform = "asdfasdf"
+    monkeypatch.setattr(sys, "platform", dummy_platform)
+
+    with pytest.raises(ValueError, match="only supports Linux systems") as excinfo:
+        import nemo_curator  # noqa
+
+    assert dummy_platform in str(excinfo.value)