diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml index c43247b..6898512 100644 --- a/.github/workflows/black.yml +++ b/.github/workflows/black.yml @@ -16,4 +16,4 @@ jobs: - name: Format code with Black uses: psf/black@stable with: - src: moojoco_env/ \ No newline at end of file + src: moojoco/ \ No newline at end of file diff --git a/README.md b/README.md index 36d5170..74af47b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- moojoco-env + moojoco-banner

-**moojoco-env** provides a unified framework for implementing and interfacing with MuJoCo and MuJoCo-XLA simulation +**moojoco** 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). @@ -15,11 +15,11 @@ 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 `ArenaConfig[requirements.txt](requirements.txt)uration` + * MJCFArena are reconfigurable via a `ArenaConfiguration` * reconfigurable via a configuration [requirements.txt](requirements.txt) -## Unified MJC and MJX environment in[README.md](README.md)terface +## Unified MJC and MJX environment interface * Reconfigurable through an environment configuration * Functional programming @@ -46,10 +46,10 @@ MuJoCo (MJC) and MuJoCo-XLA (MJX). ## Examples -For practical applications and demonstrations of **moojoco-env**, please refer to +For practical applications and demonstrations of **moojoco**, please refer to the [Bio-inspired Robotics Testbed](https://github.com/Co-Evolve/brt), which employs this framework extensively. ## Installation -``pip install moojoco-env`` \ No newline at end of file +``pip install moojoco`` \ No newline at end of file diff --git a/moojoco_env/__init__.py b/moojoco/__init__.py similarity index 100% rename from moojoco_env/__init__.py rename to moojoco/__init__.py diff --git a/moojoco_env/environment/__init__.py b/moojoco/environment/__init__.py similarity index 100% rename from moojoco_env/environment/__init__.py rename to moojoco/environment/__init__.py diff --git a/moojoco_env/environment/base.py b/moojoco/environment/base.py similarity index 98% rename from moojoco_env/environment/base.py rename to moojoco/environment/base.py index 719f0cb..6f9e4b4 100644 --- a/moojoco_env/environment/base.py +++ b/moojoco/environment/base.py @@ -11,10 +11,10 @@ from gymnasium.core import RenderFrame from mujoco import mjx -import moojoco_env.environment.mjx_spaces as mjx_spaces -from moojoco_env.mjcf.arena import MJCFArena -from moojoco_env.environment.renderer import MujocoRenderer -from moojoco_env.mjcf.morphology import MJCFMorphology +import moojoco.environment.mjx_spaces as mjx_spaces +from moojoco.mjcf.arena import MJCFArena +from moojoco.environment.renderer import MujocoRenderer +from moojoco.mjcf.morphology import MJCFMorphology class MuJoCoEnvironmentConfiguration: diff --git a/moojoco_env/environment/dual.py b/moojoco/environment/dual.py similarity index 88% rename from moojoco_env/environment/dual.py rename to moojoco/environment/dual.py index a349287..f0e792e 100644 --- a/moojoco_env/environment/dual.py +++ b/moojoco/environment/dual.py @@ -6,16 +6,16 @@ import numpy as np from gymnasium.core import RenderFrame -from moojoco_env.mjcf.arena import MJCFArena -from moojoco_env.environment.base import ( +from moojoco.mjcf.arena import MJCFArena +from moojoco.environment.base import ( BaseEnvState, BaseEnvironment, MuJoCoEnvironmentConfiguration, SpaceType, ) -from moojoco_env.environment.mjc_env import MJCEnv -from moojoco_env.environment.mjx_env import MJXEnv -from moojoco_env.mjcf.morphology import MJCFMorphology +from moojoco.environment.mjc_env import MJCEnv +from moojoco.environment.mjx_env import MJXEnv +from moojoco.mjcf.morphology import MJCFMorphology class DualMuJoCoEnvironment(BaseEnvironment): diff --git a/moojoco_env/environment/mjc_env.py b/moojoco/environment/mjc_env.py similarity index 98% rename from moojoco_env/environment/mjc_env.py rename to moojoco/environment/mjc_env.py index c9ad40e..2f68429 100644 --- a/moojoco_env/environment/mjc_env.py +++ b/moojoco/environment/mjc_env.py @@ -14,15 +14,15 @@ from gymnasium.core import ActType, RenderFrame from gymnasium.vector.utils import batch_space -from moojoco_env.environment.base import ( +from moojoco.environment.base import ( BaseEnvState, BaseEnvironment, BaseMuJoCoEnvironment, BaseObservable, MuJoCoEnvironmentConfiguration, ) -from moojoco_env.mjcf.arena import MJCFArena -from moojoco_env.mjcf.morphology import MJCFMorphology +from moojoco.mjcf.arena import MJCFArena +from moojoco.mjcf.morphology import MJCFMorphology @struct.dataclass diff --git a/moojoco_env/environment/mjx_env.py b/moojoco/environment/mjx_env.py similarity index 97% rename from moojoco_env/environment/mjx_env.py rename to moojoco/environment/mjx_env.py index d9a8dca..c463b26 100644 --- a/moojoco_env/environment/mjx_env.py +++ b/moojoco/environment/mjx_env.py @@ -13,15 +13,15 @@ from flax import struct from mujoco import mjx -import moojoco_env.environment.mjx_spaces as mjx_spaces -from moojoco_env.environment.base import ( +import moojoco.environment.mjx_spaces as mjx_spaces +from moojoco.environment.base import ( BaseEnvState, BaseMuJoCoEnvironment, BaseObservable, MuJoCoEnvironmentConfiguration, ) -from moojoco_env.mjcf.arena import MJCFArena -from moojoco_env.mjcf.morphology import MJCFMorphology +from moojoco.mjcf.arena import MJCFArena +from moojoco.mjcf.morphology import MJCFMorphology def mjx_get_model( diff --git a/moojoco_env/environment/mjx_spaces.py b/moojoco/environment/mjx_spaces.py similarity index 100% rename from moojoco_env/environment/mjx_spaces.py rename to moojoco/environment/mjx_spaces.py diff --git a/moojoco_env/environment/renderer.py b/moojoco/environment/renderer.py similarity index 100% rename from moojoco_env/environment/renderer.py rename to moojoco/environment/renderer.py diff --git a/moojoco_env/mjcf/__init__.py b/moojoco/mjcf/__init__.py similarity index 100% rename from moojoco_env/mjcf/__init__.py rename to moojoco/mjcf/__init__.py diff --git a/moojoco_env/mjcf/arena.py b/moojoco/mjcf/arena.py similarity index 90% rename from moojoco_env/mjcf/arena.py rename to moojoco/mjcf/arena.py index fd7658c..2cf40fc 100644 --- a/moojoco_env/mjcf/arena.py +++ b/moojoco/mjcf/arena.py @@ -1,6 +1,6 @@ from abc import ABC -from moojoco_env.mjcf.component import MJCFRootComponent +from moojoco.mjcf.component import MJCFRootComponent class ArenaConfiguration(ABC): diff --git a/moojoco_env/mjcf/component.py b/moojoco/mjcf/component.py similarity index 100% rename from moojoco_env/mjcf/component.py rename to moojoco/mjcf/component.py diff --git a/moojoco_env/mjcf/morphology.py b/moojoco/mjcf/morphology.py similarity index 95% rename from moojoco_env/mjcf/morphology.py rename to moojoco/mjcf/morphology.py index c1bdac5..0539345 100644 --- a/moojoco_env/mjcf/morphology.py +++ b/moojoco/mjcf/morphology.py @@ -8,7 +8,7 @@ from fprs.robot import Morphology from fprs.specification import MorphologySpecification -from moojoco_env.mjcf.component import MJCFRootComponent, MJCFSubComponent +from moojoco.mjcf.component import MJCFRootComponent, MJCFSubComponent class MJCFMorphology(Morphology, MJCFRootComponent, ABC): diff --git a/pyproject.toml b/pyproject.toml index d40720a..2eb0c30 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,8 +3,8 @@ requires = ["setuptools"] build-backend = "setuptools.build_meta" [project] -name = "moojoco-env" -version = "1.0.2" +name = "moojoco" +version = "1.0.0" authors = [ { name = "Dries Marzougui", email = "dries.marzougui@gmail.com" }, ] @@ -40,5 +40,5 @@ dependencies = [ ] [project.urls] -Homepage = "https://github.com/Co-Evolve/moojoco-env" -Repository = "https://github.com/Co-Evolve/moojoco-env" \ No newline at end of file +Homepage = "https://github.com/Co-Evolve/moojoco" +Repository = "https://github.com/Co-Evolve/moojoco" \ No newline at end of file diff --git a/setup.py b/setup.py index 671ccad..405792e 100644 --- a/setup.py +++ b/setup.py @@ -10,12 +10,12 @@ required = f.read().splitlines() setup( - name='moojoco-env', - version='1.0.2', + name='moojoco', + version='1.0.0', description='A unified framework for implementing and interfacing with MuJoCo and MuJoCo-XLA simulation ' 'environments.', long_description=readme, - url='https://github.com/Co-Evolve/moojoco-env', + url='https://github.com/Co-Evolve/moojoco', license=license, packages=find_packages(exclude=('tests', 'docs')), install_requires=required