Skip to content

Add validation script for MuJoCo shared library under tools/ #2558

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

manipratapsingh1
Copy link

This pull request adds a utility script named test_dist_validation.py under a new tools/ directory.

🔍 Purpose
The script helps verify whether the MuJoCo shared library (.so, .dll, or .dylib) located in the dist/bin/ directory exists and can be successfully loaded using Python’s ctypes module. This is useful for:

  • Validating builds and prebuilt binaries across platforms (Linux, macOS, Windows)
  • Debugging distribution issues
  • Supporting development workflows and CI pipelines

📄 How to Use

  1. Modify the lib_path variable in the script to match your platform:
    • libmujoco.so for Linux
    • mujoco.dll for Windows
    • libmujoco.dylib for macOS
  2. Run the script using:
    python tools/test_dist_validation.py

This commit introduces a utility script `test_dist_validation.py` located under the new `tools/` directory.

The script helps users and developers validate that the MuJoCo shared library in the `dist/bin/` directory exists and can be successfully loaded using Python's `ctypes` module. It supports multiple platforms and can be adapted by modifying the shared library path in the script.

Use Case:
- Quick validation of prebuilt MuJoCo distributions
- Helps diagnose missing or incompatible shared libraries
- Can be expanded or integrated into CI/test pipelines later

This contribution aims to improve the development experience and make debugging library loading issues easier.
@manipratapsingh1
Copy link
Author

Hi maintainers,

I’ve submitted this PR to add a MuJoCo distribution validation script under the tools/ directory. This utility aims to assist with ensuring package consistency and setup correctness.

The checks have passed, and I’ve signed the Google CLA. Kindly review when you get a chance. I’d be happy to make any suggested changes or improvements!

Thank you for the opportunity to contribute to this amazing project!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant