simfix 0.1.1__tar.gz → 0.1.3__tar.gz

{simfix-0.1.1/simfix.egg-info → simfix-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simfix
-Version: 0.1.1
+Version: 0.1.3
 Summary: A dependency checker and installation assistant for simulator repositories.
 Author-email: Habib ur Rehmaan <h.rehmaan96@gmail.com>
 License-Expression: MIT
@@ -102,6 +102,15 @@ Analyze a GitHub repository directly:
 simfix doctor https://github.com/user/repository.git
 ```
 
+## Environment recommendations
+
+Some simulator projects require system-level or vendor-managed dependencies such as NVIDIA drivers, CUDA, ROS, Gazebo, Isaac Gym, or Isaac Sim. SimFix does not install these automatically because they depend on the operating system, hardware, driver compatibility, administrator permissions, and vendor installation steps.
+
+Use:
+
+```bash
+simfix recommendations <repo>
+```
 ## Main commands
 
 ```bash
@@ -109,10 +118,11 @@ simfix --version
 simfix system
 simfix doctor <repo>
 simfix doctor <repo> --report
+simfix recommendations <repo>
+simfix fix <repo>
 simfix analyze <repo>
 simfix plan <repo>
 simfix commands <repo>
-simfix fix <repo>
 ```
 
 ## What SimFix can detect

{simfix-0.1.1 → simfix-0.1.3}/README.md

@@ -68,6 +68,15 @@ Analyze a GitHub repository directly:
 simfix doctor https://github.com/user/repository.git
 ```
 
+## Environment recommendations
+
+Some simulator projects require system-level or vendor-managed dependencies such as NVIDIA drivers, CUDA, ROS, Gazebo, Isaac Gym, or Isaac Sim. SimFix does not install these automatically because they depend on the operating system, hardware, driver compatibility, administrator permissions, and vendor installation steps.
+
+Use:
+
+```bash
+simfix recommendations <repo>
+```
 ## Main commands
 
 ```bash
@@ -75,10 +84,11 @@ simfix --version
 simfix system
 simfix doctor <repo>
 simfix doctor <repo> --report
+simfix recommendations <repo>
+simfix fix <repo>
 simfix analyze <repo>
 simfix plan <repo>
 simfix commands <repo>
-simfix fix <repo>
 ```
 
 ## What SimFix can detect

{simfix-0.1.1 → simfix-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simfix"
-version = "0.1.1"
+version = "0.1.3"
 description = "A dependency checker and installation assistant for simulator repositories."
 readme = "README.md"
 requires-python = ">=3.10"

{simfix-0.1.1 → simfix-0.1.3}/simfix/__init__.py

@@ -1,3 +1,3 @@
 """SimFix package."""
 
-__version__ = "0.1.1"
+__version__ = "0.1.3"

{simfix-0.1.1 → simfix-0.1.3}/simfix/cli.py

@@ -16,7 +16,7 @@ from simfix.pypi import check_pypi_packages
 from simfix.repo import clone_repo, is_git_url
 from simfix.report import generate_markdown_report, write_markdown_report
 from simfix.system import get_system_info
-
+from simfix.recommendations import generate_recommendations
 
 console = Console()
 
@@ -58,6 +58,33 @@ def _resolve_repo_path(repo: str) -> Path:
     return Path(repo)
 
 
+def print_recommendations_table(recommendations: list) -> None:
+    """Print system and vendor dependency recommendations."""
+    if not recommendations:
+        console.print(
+            "[green]No additional system or vendor recommendations found.[/green]"
+        )
+        return
+
+    table = Table(title="Environment compatibility recommendations")
+    table.add_column("Category")
+    table.add_column("Status")
+    table.add_column("Title")
+    table.add_column("Reason")
+    table.add_column("Suggestion")
+
+    for recommendation in recommendations:
+        table.add_row(
+            recommendation.category,
+            recommendation.status,
+            recommendation.title,
+            recommendation.reason,
+            recommendation.suggestion,
+        )
+
+    console.print(table)
+
+
 @app.command()
 def analyze(repo: str) -> None:
     """Analyze repository dependency files without system diagnostics."""
@@ -84,6 +111,23 @@ def analyze(repo: str) -> None:
     console.print(f"[bold]Detected ecosystem(s):[/bold] {ecosystems}")
 
 
+@app.command()
+def recommendations(repo: str) -> None:
+    """Show environment compatibility and manual dependency guidance."""
+    repo_path = Path(repo).expanduser().resolve()
+    analysis = analyze_repo(repo_path)
+
+    repo_recommendations = generate_recommendations(
+        dependencies=analysis.all_python_dependencies,
+        detected_ecosystems=analysis.detected_ecosystems,
+    )
+
+    console.print("[bold]SimFix Recommendations[/bold]")
+    console.print(f"Repository: {repo_path}")
+
+    print_recommendations_table(repo_recommendations)
+
+
 @app.command()
 def plan(repo: str) -> None:
     """Generate a recommended installation plan for a repository."""
@@ -358,6 +402,18 @@ def doctor(
 
         console.print(warning_table)
 
+    repo_recommendations = generate_recommendations(
+        dependencies=analysis.all_python_dependencies,
+        detected_ecosystems=analysis.detected_ecosystems,
+    )
+
+    if repo_recommendations:
+        console.print()
+        console.print(
+            "[yellow]System/vendor recommendations found.[/yellow] "
+            f"Run: simfix recommendations {repo_path}"
+        )
+
     if report:
         report_text = generate_markdown_report(
             analysis=analysis,

simfix-0.1.3/simfix/recommendations.py

@@ -0,0 +1,131 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Recommendation:
+    """A safe recommendation for a system or vendor dependency."""
+
+    category: str
+    title: str
+    status: str
+    reason: str
+    suggestion: str
+
+
+def generate_recommendations(
+    dependencies: list[str],
+    detected_ecosystems: list[str],
+) -> list[Recommendation]:
+    """Generate safe system and vendor dependency recommendations.
+
+    This function does not install drivers, ROS, CUDA, or vendor tools.
+    It only detects likely requirements and returns guidance.
+    """
+    recommendations: list[Recommendation] = []
+
+    normalized_dependencies = [dependency.lower() for dependency in dependencies]
+
+    normalized_ecosystems = [ecosystem.lower() for ecosystem in detected_ecosystems]
+
+    has_isaacgym = any(
+        "isaacgym" in dependency for dependency in normalized_dependencies
+    )
+    has_isaacsim = any(
+        "isaacsim" in dependency or "omni.isaac" in dependency
+        for dependency in normalized_dependencies
+    )
+    has_cuda_dependency = any(
+        _has_cuda_keyword(dependency) for dependency in normalized_dependencies
+    )
+    has_ros = "ros" in normalized_ecosystems
+
+    if has_isaacgym:
+        recommendations.append(
+            Recommendation(
+                category="Vendor-managed dependency",
+                title="NVIDIA Isaac Gym required",
+                status="Manual installation required",
+                reason=(
+                    "The dependency 'isaacgym' was detected, but it is not "
+                    "available as a normal PyPI package."
+                ),
+                suggestion=(
+                    "Install NVIDIA Isaac Gym manually in a compatible Linux "
+                    "environment with NVIDIA GPU support. If the local machine "
+                    "is not suitable, use an HPC GPU node or cloud GPU instance."
+                ),
+            )
+        )
+
+    if has_isaacsim:
+        recommendations.append(
+            Recommendation(
+                category="Vendor-managed dependency",
+                title="NVIDIA Isaac Sim required",
+                status="Manual installation required",
+                reason=(
+                    "Isaac Sim or omni.isaac dependencies were detected. "
+                    "These are NVIDIA-managed dependencies."
+                ),
+                suggestion=(
+                    "Install Isaac Sim using NVIDIA's official installation "
+                    "method. Use a supported system with compatible NVIDIA GPU "
+                    "drivers."
+                ),
+            )
+        )
+
+    if has_isaacgym or has_isaacsim or has_cuda_dependency:
+        recommendations.append(
+            Recommendation(
+                category="GPU/CUDA",
+                title="CUDA-compatible environment recommended",
+                status="Check required",
+                reason=(
+                    "GPU/CUDA-related dependencies were detected in the " "repository."
+                ),
+                suggestion=(
+                    "Use a compatible Linux/NVIDIA GPU environment. If the "
+                    "local GPU is not CUDA-compatible, consider a Docker setup "
+                    "on a compatible machine, an HPC GPU node, a cloud GPU "
+                    "instance, or CPU-only mode if the simulator supports it."
+                ),
+            )
+        )
+
+    if has_ros:
+        recommendations.append(
+            Recommendation(
+                category="ROS",
+                title="ROS environment required",
+                status="Manual installation required",
+                reason="ROS package files were detected in the repository.",
+                suggestion=(
+                    "Use a matching ROS Docker image or install the correct "
+                    "ROS distribution manually. For ROS 1/catkin projects, "
+                    "ROS Noetic on Ubuntu 20.04 is commonly used. For ROS "
+                    "2/ament projects, ROS Humble on Ubuntu 22.04 is commonly "
+                    "used."
+                ),
+            )
+        )
+
+    return recommendations
+
+
+def _has_cuda_keyword(dependency: str) -> bool:
+    """Return True if a dependency suggests GPU/CUDA requirements."""
+    cuda_keywords = [
+        "cuda",
+        "cudnn",
+        "cupy",
+        "pytorch3d",
+        "onnxruntime-gpu",
+        "tensorflow-gpu",
+        "jax[cuda",
+        "numba.cuda",
+    ]
+
+    return any(keyword in dependency for keyword in cuda_keywords)

{simfix-0.1.1 → simfix-0.1.3/simfix.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simfix
-Version: 0.1.1
+Version: 0.1.3
 Summary: A dependency checker and installation assistant for simulator repositories.
 Author-email: Habib ur Rehmaan <h.rehmaan96@gmail.com>
 License-Expression: MIT
@@ -102,6 +102,15 @@ Analyze a GitHub repository directly:
 simfix doctor https://github.com/user/repository.git
 ```
 
+## Environment recommendations
+
+Some simulator projects require system-level or vendor-managed dependencies such as NVIDIA drivers, CUDA, ROS, Gazebo, Isaac Gym, or Isaac Sim. SimFix does not install these automatically because they depend on the operating system, hardware, driver compatibility, administrator permissions, and vendor installation steps.
+
+Use:
+
+```bash
+simfix recommendations <repo>
+```
 ## Main commands
 
 ```bash
@@ -109,10 +118,11 @@ simfix --version
 simfix system
 simfix doctor <repo>
 simfix doctor <repo> --report
+simfix recommendations <repo>
+simfix fix <repo>
 simfix analyze <repo>
 simfix plan <repo>
 simfix commands <repo>
-simfix fix <repo>
 ```
 
 ## What SimFix can detect

{simfix-0.1.1 → simfix-0.1.3}/simfix.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ simfix/planner.py
 simfix/pypi.py
 simfix/pyproject.py
 simfix/python_requirements.py
+simfix/recommendations.py
 simfix/repo.py
 simfix/report.py
 simfix/ros_docker.py

{simfix-0.1.1 → simfix-0.1.3}/tests/test_basic.py

@@ -10,6 +10,7 @@ from simfix.conda_fixer import fix_conda_environment_file
 from simfix.cuda_docker import create_cuda_dockerfile, detect_gpu_project
 from simfix.docker_runner import create_docker_run_helper
 from simfix.dockerfile import parse_dockerfile
+from simfix.recommendations import generate_recommendations
 from simfix.fixer import (
     extract_direct_pin_conflict,
     fix_pyproject_with_uv,
@@ -27,6 +28,11 @@ from simfix.report import generate_markdown_report, write_markdown_report
 from simfix.ros_docker import create_ros_dockerfile
 from simfix.ros_package import parse_ros_package
 from simfix.setup_py import parse_setup_py_dependencies
+
+from typer.testing import CliRunner
+
+from simfix.cli import app
+
 from simfix.system import (
     SystemInfo,
     command_exists,
@@ -39,7 +45,7 @@ from simfix.system import (
 
 
 def test_version() -> None:
-    assert __version__ == "0.1.1"
+    assert __version__ == "0.1.3"
 
 
 def test_analyze_python_repo(tmp_path: Path) -> None:
@@ -1117,3 +1123,100 @@ def test_remove_direct_requirement_pin() -> None:
     )
 
     assert fixed_text == "urdfpy==0.0.22\nnumpy==1.23\n"
+
+
+def test_generate_recommendations_detects_isaacgym() -> None:
+    recommendations = generate_recommendations(
+        dependencies=["isaacgym", "torch"],
+        detected_ecosystems=["python"],
+    )
+
+    titles = [recommendation.title for recommendation in recommendations]
+
+    assert "NVIDIA Isaac Gym required" in titles
+    assert "CUDA-compatible environment recommended" in titles
+
+
+def test_generate_recommendations_detects_isaacsim() -> None:
+    recommendations = generate_recommendations(
+        dependencies=["omni.isaac.core"],
+        detected_ecosystems=["python"],
+    )
+
+    titles = [recommendation.title for recommendation in recommendations]
+
+    assert "NVIDIA Isaac Sim required" in titles
+    assert "CUDA-compatible environment recommended" in titles
+
+
+def test_generate_recommendations_detects_ros() -> None:
+    recommendations = generate_recommendations(
+        dependencies=[],
+        detected_ecosystems=["ros"],
+    )
+
+    titles = [recommendation.title for recommendation in recommendations]
+
+    assert "ROS environment required" in titles
+
+
+def test_generate_recommendations_empty_for_simple_python_project() -> None:
+    recommendations = generate_recommendations(
+        dependencies=["numpy", "matplotlib"],
+        detected_ecosystems=["python"],
+    )
+
+    assert recommendations == []
+
+
+def test_recommendations_command_simple_repo(tmp_path: Path) -> None:
+    repo = tmp_path / "repo"
+    repo.mkdir()
+    (repo / "requirements.txt").write_text("numpy\n", encoding="utf-8")
+
+    runner = CliRunner()
+    result = runner.invoke(app, ["recommendations", str(repo)])
+
+    assert result.exit_code == 0
+    assert "SimFix Recommendations" in result.output
+
+
+def test_recommendations_command_detects_isaacgym(tmp_path: Path) -> None:
+    repo = tmp_path / "repo"
+    repo.mkdir()
+    (repo / "requirements.txt").write_text("isaacgym\n", encoding="utf-8")
+
+    runner = CliRunner()
+    result = runner.invoke(app, ["recommendations", str(repo)])
+
+    assert result.exit_code == 0
+    assert "isaacgym" in result.output.lower()
+
+
+def test_doctor_shows_recommendations_hint_for_vendor_dependency(
+    tmp_path: Path,
+) -> None:
+    repo = tmp_path / "repo"
+    repo.mkdir()
+    (repo / "requirements.txt").write_text("isaacgym\n", encoding="utf-8")
+
+    runner = CliRunner()
+    result = runner.invoke(app, ["doctor", str(repo)])
+
+    assert result.exit_code == 0
+    assert "System/vendor recommendations found" in result.output
+    assert "simfix recommendations" in result.output
+
+
+def test_doctor_does_not_show_recommendations_hint_for_simple_repo(
+    tmp_path: Path,
+) -> None:
+    repo = tmp_path / "repo"
+    repo.mkdir()
+    (repo / "requirements.txt").write_text("numpy\n", encoding="utf-8")
+
+    runner = CliRunner()
+    result = runner.invoke(app, ["doctor", str(repo)])
+
+    assert result.exit_code == 0
+    assert "System/vendor recommendations found" not in result.output