Skip to content

Commit

Permalink
added pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
driesmarzougui committed Feb 9, 2024
1 parent 14a1fec commit 8efb1df
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand All @@ -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
Expand All @@ -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
Expand Down
44 changes: 44 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]"},
]
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"

0 comments on commit 8efb1df

Please sign in to comment.