From 8efb1df4533fad226efe30e8268dc63ed83c0140 Mon Sep 17 00:00:00 2001 From: dmarzoug Date: Fri, 9 Feb 2024 14:10:50 +0100 Subject: [PATCH] added pyproject.toml --- README.md | 10 +++++----- pyproject.toml | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 5 deletions(-) create mode 100644 pyproject.toml diff --git a/README.md b/README.md index ff22c0b..0df2384 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # mujoco-utils -MuJoCo-utils provides a framework for implementing and interfacing with MuJoCo and MuJoCo-XLA simulation environments. +MuJoCo-utils provides a unified framework for implementing and interfacing with MuJoCo and MuJoCo-XLA simulation environments. The main goal of this framework is to **unify** the development and interfaces of environments implemented in native MuJoCo (MJC) and MuJoCo-XLA (MJX). @@ -12,10 +12,10 @@ MuJoCo (MJC) and MuJoCo-XLA (MJX). the [Framework for Parameterized Robot Specifications (FPRS)](https://github.com/Co-Evolve/fprs). * MJCFMorphologies follow a modular design, dividing the robot into distinct parts. * MJCFArena defines the arena in which the robot is places (i.e. all non-morphological structures). - * MJCFArena are reconfigurable via a `ArenaConfiguration` + * MJCFArena are reconfigurable via a `ArenaConfig[requirements.txt](requirements.txt)uration` * reconfigurable via a configuration - -## Unified MJC and MJX environment interface +[requirements.txt](requirements.txt) +## Unified MJC and MJX environment in[README.md](README.md)terface * Reconfigurable through an environment configuration * Functional programming @@ -35,7 +35,7 @@ MuJoCo (MJC) and MuJoCo-XLA (MJX). uses numpy arrays. * Observations are implemented using Observables; these define retriever functions that extract the observation based on the state datastructure and provide an easy way to implement observations. -* 'DualMuJocoEnvironment' provides the unification of MJC and MJX, and allows conditional environment creation based on +* DualMuJocoEnvironment provides the unification of MJC and MJX, and allows conditional environment creation based on a backend string. * Both MJC and MJX support human-mode and rgb_array rendering modes. * Note: MJX rendering is slow due to the offloading of datastructures of the GPU diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..79a1fdd --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,44 @@ +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project] +name="mujoco-utils" +version = "1.0.0" +authors = [ + {name = "Dries Marzougui", email = "dries.marzougui@gmail.com"}, +] +description = "A unified framework for implementing and interfacing with MuJoCo and MuJoCo-XLA simulation environments." +readme = {file = "README.md", content-type = "text/markdown"} +license = {text = "Apache License 2.0"} +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "Intended Audience :: Science/Research", + "Natural Language :: English", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Topic :: Scientific/Engineering", +] +requires-python = ">=3.8" +dependencies = [ + "chex", + "dm-control", + "flax", + "fprs", + "glfw", + "gymnasium", + "imageio", + "mujoco", + "mujoco-mjx", + "numpy", + "scipy", +] + +[project.urls] +Homepage = "https://github.com/Co-Evolve/mujoco-utils" +Repository = "https://github.com/Co-Evolve/mujoco-utils" \ No newline at end of file