simfix 0.1.0__tar.gz → 0.1.2__tar.gz

simfix-0.1.2/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: simfix
+Version: 0.1.2
+Summary: A dependency checker and installation assistant for simulator repositories.
+Author-email: Habib ur Rehmaan <h.rehmaan96@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hrehmaan/simfix
+Project-URL: Repository, https://github.com/hrehmaan/simfix
+Project-URL: Issues, https://github.com/hrehmaan/simfix/issues
+Keywords: simulator,dependencies,installation,docker,cuda,ros
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich
+Requires-Dist: typer
+Requires-Dist: requests
+Requires-Dist: packaging
+Requires-Dist: pyyaml
+Requires-Dist: uv
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# SimFix
+
+SimFix is a command-line tool for diagnosing and fixing common setup problems in simulator repositories.
+
+It inspects a project, detects dependency files, checks Python packages, reports system requirements, and suggests a safe installation plan.
+
+## Installation
+
+Install SimFix from PyPI:
+
+```bash
+pip install simfix
+```
+
+Check that it installed correctly:
+
+```bash
+simfix --version
+```
+
+You can also check your system:
+
+```bash
+simfix system
+```
+
+## Quick start
+
+Analyze a simulator repository:
+
+```bash
+simfix doctor <repo>
+```
+
+Example:
+
+```bash
+simfix doctor ../my_simulator_repo
+```
+
+Apply supported automatic fixes:
+
+```bash
+simfix fix <repo>
+```
+
+Generate an installation plan:
+
+```bash
+simfix plan <repo>
+```
+
+Show suggested installation commands:
+
+```bash
+simfix commands <repo>
+```
+
+Generate a Markdown report:
+
+```bash
+simfix doctor <repo> --report
+```
+
+Analyze a GitHub repository directly:
+
+```bash
+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
+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>
+```
+
+## What SimFix can detect
+
+SimFix currently detects:
+
+* `requirements.txt`
+* `setup.py`
+* `pyproject.toml`
+* `environment.yml` / `environment.yaml`
+* `Dockerfile`
+* `package.xml`
+* `CMakeLists.txt`
+
+## What SimFix can fix
+
+The `simfix fix` command currently supports:
+
+* Resolving `requirements.txt` using `uv`
+* Normalizing invalid pip syntax such as `package=version` to `package==version`
+* Repairing clear dependency conflicts by removing direct conflicting pins and letting the resolver choose compatible versions
+* Cleaning duplicate dependencies in `environment.yml`
+* Creating CUDA/GPU Dockerfiles for GPU-based simulator projects
+* Creating ROS Dockerfiles from `package.xml`
+* Creating Docker run helper scripts
+* Initializing Git submodules
+* Pulling Git LFS assets when Git LFS is available
+
+SimFix always modifies files in place, so review changes with:
+
+```bash
+git diff
+```
+
+## Example
+
+```bash
+simfix doctor ../my_simulator_repo
+```
+
+Example output:
+
+```text
+SimFix Doctor
+Repository: /path/to/my_simulator_repo
+
+Detected dependency files
+requirements.txt: yes
+setup.py: yes
+Dockerfile: no
+
+Detected ecosystem(s): python
+
+PyPI check
+numpy: found
+matplotlib: found
+isaacgym: not found
+
+Recommendation:
+Some dependencies are not available on PyPI.
+Manual/vendor installation may be required.
+```
+
+## Important notes
+
+SimFix does not install GPU drivers, CUDA drivers, ROS, Isaac Gym, Isaac Sim, or other vendor software automatically.
+
+For GPU simulator projects, SimFix may create a CUDA Dockerfile, but your machine still needs a working NVIDIA driver and NVIDIA Container Toolkit to run GPU containers.
+
+Some packages, such as NVIDIA Isaac Gym, are not available on PyPI and must be installed manually.
+
+## Development installation
+
+For contributors, clone the repository:
+
+```bash
+git clone https://github.com/hrehmaan/simfix.git
+cd simfix
+```
+
+Install in editable mode:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+Install pre-commit hooks:
+
+```bash
+pre-commit install
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+Run all checks:
+
+```bash
+pre-commit run --all-files
+```
+
+## Project status
+
+SimFix is in early development.
+
+The goal is to make simulator setup easier by combining repository analysis, system diagnostics, dependency checks, resolver-based repair, Docker guidance, and clear warnings for manual/vendor dependencies.
+
+## Contributing
+
+Contributions are welcome.
+
+Before opening a pull request, please first create an issue describing the bug, feature request, or improvement you want to work on. This helps avoid duplicate work and makes it easier to discuss the best solution before implementation.
+
+Recommended contribution workflow:
+
+```bash
+# 1. Create an issue on GitHub first
+# 2. Fork the repository
+# 3. Create a new branch
+git checkout -b fix-or-feature-name
+
+# 4. Make your changes
+# 5. Run checks
+pytest
+pre-commit run --all-files
+
+# 6. Open a pull request and link it to the issue

simfix-0.1.2/README.md

@@ -0,0 +1,221 @@
+# SimFix
+
+SimFix is a command-line tool for diagnosing and fixing common setup problems in simulator repositories.
+
+It inspects a project, detects dependency files, checks Python packages, reports system requirements, and suggests a safe installation plan.
+
+## Installation
+
+Install SimFix from PyPI:
+
+```bash
+pip install simfix
+```
+
+Check that it installed correctly:
+
+```bash
+simfix --version
+```
+
+You can also check your system:
+
+```bash
+simfix system
+```
+
+## Quick start
+
+Analyze a simulator repository:
+
+```bash
+simfix doctor <repo>
+```
+
+Example:
+
+```bash
+simfix doctor ../my_simulator_repo
+```
+
+Apply supported automatic fixes:
+
+```bash
+simfix fix <repo>
+```
+
+Generate an installation plan:
+
+```bash
+simfix plan <repo>
+```
+
+Show suggested installation commands:
+
+```bash
+simfix commands <repo>
+```
+
+Generate a Markdown report:
+
+```bash
+simfix doctor <repo> --report
+```
+
+Analyze a GitHub repository directly:
+
+```bash
+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
+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>
+```
+
+## What SimFix can detect
+
+SimFix currently detects:
+
+* `requirements.txt`
+* `setup.py`
+* `pyproject.toml`
+* `environment.yml` / `environment.yaml`
+* `Dockerfile`
+* `package.xml`
+* `CMakeLists.txt`
+
+## What SimFix can fix
+
+The `simfix fix` command currently supports:
+
+* Resolving `requirements.txt` using `uv`
+* Normalizing invalid pip syntax such as `package=version` to `package==version`
+* Repairing clear dependency conflicts by removing direct conflicting pins and letting the resolver choose compatible versions
+* Cleaning duplicate dependencies in `environment.yml`
+* Creating CUDA/GPU Dockerfiles for GPU-based simulator projects
+* Creating ROS Dockerfiles from `package.xml`
+* Creating Docker run helper scripts
+* Initializing Git submodules
+* Pulling Git LFS assets when Git LFS is available
+
+SimFix always modifies files in place, so review changes with:
+
+```bash
+git diff
+```
+
+## Example
+
+```bash
+simfix doctor ../my_simulator_repo
+```
+
+Example output:
+
+```text
+SimFix Doctor
+Repository: /path/to/my_simulator_repo
+
+Detected dependency files
+requirements.txt: yes
+setup.py: yes
+Dockerfile: no
+
+Detected ecosystem(s): python
+
+PyPI check
+numpy: found
+matplotlib: found
+isaacgym: not found
+
+Recommendation:
+Some dependencies are not available on PyPI.
+Manual/vendor installation may be required.
+```
+
+## Important notes
+
+SimFix does not install GPU drivers, CUDA drivers, ROS, Isaac Gym, Isaac Sim, or other vendor software automatically.
+
+For GPU simulator projects, SimFix may create a CUDA Dockerfile, but your machine still needs a working NVIDIA driver and NVIDIA Container Toolkit to run GPU containers.
+
+Some packages, such as NVIDIA Isaac Gym, are not available on PyPI and must be installed manually.
+
+## Development installation
+
+For contributors, clone the repository:
+
+```bash
+git clone https://github.com/hrehmaan/simfix.git
+cd simfix
+```
+
+Install in editable mode:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+Install pre-commit hooks:
+
+```bash
+pre-commit install
+```
+
+Run tests:
+
+```bash
+pytest
+```
+
+Run all checks:
+
+```bash
+pre-commit run --all-files
+```
+
+## Project status
+
+SimFix is in early development.
+
+The goal is to make simulator setup easier by combining repository analysis, system diagnostics, dependency checks, resolver-based repair, Docker guidance, and clear warnings for manual/vendor dependencies.
+
+## Contributing
+
+Contributions are welcome.
+
+Before opening a pull request, please first create an issue describing the bug, feature request, or improvement you want to work on. This helps avoid duplicate work and makes it easier to discuss the best solution before implementation.
+
+Recommended contribution workflow:
+
+```bash
+# 1. Create an issue on GitHub first
+# 2. Fork the repository
+# 3. Create a new branch
+git checkout -b fix-or-feature-name
+
+# 4. Make your changes
+# 5. Run checks
+pytest
+pre-commit run --all-files
+
+# 6. Open a pull request and link it to the issue

{simfix-0.1.0 → simfix-0.1.2}/pyproject.toml

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

{simfix-0.1.0 → simfix-0.1.2}/simfix/__init__.py

@@ -1,3 +1,3 @@
 """SimFix package."""
 
-__version__ = "0.1.0"
+__version__ = "0.1.2"

{simfix-0.1.0 → simfix-0.1.2}/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.2/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)