---
layout: default
title: "ReplicantDriveSim"
permalink: /
---
# ReplicantDriveSim
ReplicantDriveSim is an advanced traffic simulation project designed for autonomous driving research. It leverages reinforcement learning, imitation learning, and computer vision to create realistic traffic scenarios and synthetic driving data. The simulation environment is built using Pygame for visualization and Miniforge for Python package management, ensuring a seamless development and deployment experience. This Docker image provides a fully configured environment with all necessary dependencies, enabling efficient experimentation and development of autonomous driving algorithms.
[Traffic Simulation Documentation](https://chrisjcc.github.io/ReplicantDriveSim/)
[Doxygen Documentation](https://chrisjcc.github.io/ReplicantDriveSim/External/docs/html/)
[AI Page](https://chrisjcc.github.io/ReplicantDriveSim/rl/)
[GitHub Page](https://github.com/chrisjcc/ReplicantDriveSim/)
[Read the Docs](https://replicantdrivesim.readthedocs.io/en/latest/)
## Accessing ReplicantDriveSim Library via PyPI
The `ReplicantDriveSim` library is available on the Python Package Index (PyPI). You can find it at [https://pypi.org/project/ReplicantDriveSim/](https://pypi.org/project/ReplicantDriveSim/).
### Installation
To install the latest version of `ReplicantDriveSim`, use the following pip command:
```bash
pip install ReplicantDriveSim
```
This command will download and install the package along with its dependencies. After installation, you can import the library in your Python scripts:
```python
import replicantdrivesim
```
For more detailed usage instructions, please refer to the documentation in the repository.
## Project Setup
### Required Unity Version
This project was developed using Unity 2022.3.39f1 (LTS). To ensure compatibility, please use this version or later Long-Term Support (LTS) versions of Unity. You can download the specific version from the Unity Hub or the Unity Archive.
#### Installation:
1. Clone the repository:
```shell
git clone git@github.com:chrisjcc/ReplicantDriveSim.git
```
2. Open the project in Unity Hub and select Unity version 2022.3.39f1.
3. Let Unity install any necessary packages and dependencies.
## Generate Doxygen Documentation
To generate the documentation for this project using Doxygen, follow these steps:
#### Building the Unity Project from Command Line
To generate an executable for this Unity project without opening the Unity Editor, you can use the following command in your terminal:
```bash
/Applications/Unity/Hub/Editor/2022.3.33f1/Unity.app/Contents/MacOS/Unity \
-quit \
-batchmode \
-nographics \
-projectPath "/Users/christiancontrerascampana/Desktop/project/unity_traffic_simulation/reduce_git_lfs/UnityDriveSimulation" \
-executeMethod UnityDriveSimulation.BuildTools.BuildScript.PerformMacOSBuild \
-logFile "Logs/logfile.log"
```
##### Command Breakdown
Let's break down what each part of this command does:
1. `/Applications/Unity/Hub/Editor/2022.3.33f1/Unity.app/Contents/MacOS/Unity`
- This is the path to the Unity executable on macOS. Adjust this path if your Unity installation is in a different location or if you're using a different version.
2. `-quit`
- This parameter tells Unity to quit after executing the build process. It ensures that Unity doesn't stay open after the build is complete.
3. `-batchmode`
- This runs Unity in batch mode, which means it operates without launching the graphical user interface. This is essential for automated builds and running Unity from the command line.
4. `-projectPath "/Users/christiancontrerascampana/Desktop/project/unity_traffic_simulation/reduce_git_lfs/UnityDriveSimulation"`
- This specifies the path to your Unity project. Replace this with the actual path to your project on your machine.
5. `-executeMethod UnityDriveSimulation.BuildTools.BuildScript.PerformMacOSBuild`
- This tells Unity which method to execute to perform the build. In this case, it's calling the `PerformMacOSBuild` method from the `BuildScript` class in the `UnityDriveSimulation.BuildTools` namespace.
6. `-logFile "Logs/logfile.log"`
- This specifies where Unity should output its log file. This is useful for debugging if something goes wrong during the build process.
##### Usage
To use this command:
1. Open a terminal window.
2. Navigate to the directory containing your Unity project.
3. Copy and paste the above command, making sure to adjust the Unity executable path and project path as necessary for your system.
4. Press Enter to run the command.
The build process will start, and Unity will generate the executable based on your project settings and the build script you've defined in `UnityDriveSimulation.BuildTools.BuildScript.PerformMacOSBuild`.
#### Note
Ensure that the build script (`BuildScript.cs`) is properly set up in your Unity project and that the `PerformMacOSBuild` method is correctly implemented to build your project for macOS.
### Prerequisites
Make sure Doxygen is installed on your local machine. You can install it using the following commands:
- **Ubuntu:**
```bash
sudo apt-get install doxygen
sudo apt-get install graphviz
```
- **macOS:**
```bash
brew install doxygen
brew install graphviz
```
### Generate Documentation
1. Navigate to the root directory of your project where the Doxyfile is located.
2. Run the Doxygen command with your Doxyfile to generate the documentation:
```bash
doxygen Doxyfile
```
3. The generated HTML files can be found in the directory specified by the OUTPUT_DIRECTORY setting in the Doxyfile (typically docs/html).
Raw data
{
"_id": null,
"home_page": null,
"name": "ReplicantDriveSim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "traffic, simulation, autonomous driving, reinforcement learning, multi-agent reinforcement learning, rl, marl",
"author": "Christian Contreras Campana",
"author_email": "chrisjcc.physics@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4e/fa/f14a7be80c19f7ad1769778b2be5b0691914a8d095d6c42f2b0e84c2309d/ReplicantDriveSim-0.4.7.tar.gz",
"platform": null,
"description": "---\nlayout: default\ntitle: \"ReplicantDriveSim\"\npermalink: /\n---\n\n\n\n# ReplicantDriveSim\n\nReplicantDriveSim is an advanced traffic simulation project designed for autonomous driving research. It leverages reinforcement learning, imitation learning, and computer vision to create realistic traffic scenarios and synthetic driving data. The simulation environment is built using Pygame for visualization and Miniforge for Python package management, ensuring a seamless development and deployment experience. This Docker image provides a fully configured environment with all necessary dependencies, enabling efficient experimentation and development of autonomous driving algorithms.\n\n[Traffic Simulation Documentation](https://chrisjcc.github.io/ReplicantDriveSim/)\n\n[Doxygen Documentation](https://chrisjcc.github.io/ReplicantDriveSim/External/docs/html/)\n\n[AI Page](https://chrisjcc.github.io/ReplicantDriveSim/rl/)\n\n[GitHub Page](https://github.com/chrisjcc/ReplicantDriveSim/)\n\n[Read the Docs](https://replicantdrivesim.readthedocs.io/en/latest/)\n\n\n\n## Accessing ReplicantDriveSim Library via PyPI\n\nThe `ReplicantDriveSim` library is available on the Python Package Index (PyPI). You can find it at [https://pypi.org/project/ReplicantDriveSim/](https://pypi.org/project/ReplicantDriveSim/).\n\n### Installation\n\nTo install the latest version of `ReplicantDriveSim`, use the following pip command:\n\n```bash\npip install ReplicantDriveSim\n```\n\nThis command will download and install the package along with its dependencies. After installation, you can import the library in your Python scripts:\n\n```python\nimport replicantdrivesim\n```\n\nFor more detailed usage instructions, please refer to the documentation in the repository.\n\n## Project Setup\n\n### Required Unity Version\n\nThis project was developed using Unity 2022.3.39f1 (LTS). To ensure compatibility, please use this version or later Long-Term Support (LTS) versions of Unity. You can download the specific version from the Unity Hub or the Unity Archive.\n\n#### Installation:\n\n1. Clone the repository:\n ```shell\n git clone git@github.com:chrisjcc/ReplicantDriveSim.git\n ```\n2. Open the project in Unity Hub and select Unity version 2022.3.39f1.\n3. Let Unity install any necessary packages and dependencies.\n\n## Generate Doxygen Documentation\n\nTo generate the documentation for this project using Doxygen, follow these steps:\n\n\n#### Building the Unity Project from Command Line\n\nTo generate an executable for this Unity project without opening the Unity Editor, you can use the following command in your terminal:\n\n```bash\n/Applications/Unity/Hub/Editor/2022.3.33f1/Unity.app/Contents/MacOS/Unity \\\n-quit \\\n-batchmode \\\n-nographics \\\n-projectPath \"/Users/christiancontrerascampana/Desktop/project/unity_traffic_simulation/reduce_git_lfs/UnityDriveSimulation\" \\\n-executeMethod UnityDriveSimulation.BuildTools.BuildScript.PerformMacOSBuild \\\n-logFile \"Logs/logfile.log\"\n```\n\n##### Command Breakdown\n\nLet's break down what each part of this command does:\n\n1. `/Applications/Unity/Hub/Editor/2022.3.33f1/Unity.app/Contents/MacOS/Unity`\n - This is the path to the Unity executable on macOS. Adjust this path if your Unity installation is in a different location or if you're using a different version.\n\n2. `-quit`\n - This parameter tells Unity to quit after executing the build process. It ensures that Unity doesn't stay open after the build is complete.\n\n3. `-batchmode`\n - This runs Unity in batch mode, which means it operates without launching the graphical user interface. This is essential for automated builds and running Unity from the command line.\n\n4. `-projectPath \"/Users/christiancontrerascampana/Desktop/project/unity_traffic_simulation/reduce_git_lfs/UnityDriveSimulation\"`\n - This specifies the path to your Unity project. Replace this with the actual path to your project on your machine.\n\n5. `-executeMethod UnityDriveSimulation.BuildTools.BuildScript.PerformMacOSBuild`\n - This tells Unity which method to execute to perform the build. In this case, it's calling the `PerformMacOSBuild` method from the `BuildScript` class in the `UnityDriveSimulation.BuildTools` namespace.\n\n6. `-logFile \"Logs/logfile.log\"`\n - This specifies where Unity should output its log file. This is useful for debugging if something goes wrong during the build process.\n\n##### Usage\n\nTo use this command:\n\n1. Open a terminal window.\n2. Navigate to the directory containing your Unity project.\n3. Copy and paste the above command, making sure to adjust the Unity executable path and project path as necessary for your system.\n4. Press Enter to run the command.\n\nThe build process will start, and Unity will generate the executable based on your project settings and the build script you've defined in `UnityDriveSimulation.BuildTools.BuildScript.PerformMacOSBuild`.\n\n#### Note\n\nEnsure that the build script (`BuildScript.cs`) is properly set up in your Unity project and that the `PerformMacOSBuild` method is correctly implemented to build your project for macOS.\n\n\n### Prerequisites\n\nMake sure Doxygen is installed on your local machine. You can install it using the following commands:\n\n- **Ubuntu:**\n ```bash\n sudo apt-get install doxygen\n sudo apt-get install graphviz\n ```\n- **macOS:**\n ```bash\n brew install doxygen\n brew install graphviz\n ```\n\n### Generate Documentation\n\n1. Navigate to the root directory of your project where the Doxyfile is located.\n2. Run the Doxygen command with your Doxyfile to generate the documentation:\n ```bash\n doxygen Doxyfile\n ```\n3. The generated HTML files can be found in the directory specified by the OUTPUT_DIRECTORY setting in the Doxyfile (typically docs/html).\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Unity Traffic Simulation",
"version": "0.4.7",
"project_urls": null,
"split_keywords": [
"traffic",
" simulation",
" autonomous driving",
" reinforcement learning",
" multi-agent reinforcement learning",
" rl",
" marl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2647f4b2648eb134887395a104761a61224aa5001fa43eeee7d2e23a4c432d92",
"md5": "95435e320eec9ad856f368b5701172d3",
"sha256": "00edb41d46223775f45c3ae1e3c795b616ec8433770b2b4380b8e5e4749f9ee8"
},
"downloads": -1,
"filename": "ReplicantDriveSim-0.4.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "95435e320eec9ad856f368b5701172d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 92382806,
"upload_time": "2024-10-22T23:31:57",
"upload_time_iso_8601": "2024-10-22T23:31:57.969099Z",
"url": "https://files.pythonhosted.org/packages/26/47/f4b2648eb134887395a104761a61224aa5001fa43eeee7d2e23a4c432d92/ReplicantDriveSim-0.4.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4efaf14a7be80c19f7ad1769778b2be5b0691914a8d095d6c42f2b0e84c2309d",
"md5": "bee1115dc3292b6bd4d2dc9c229266b2",
"sha256": "41d52e7abf38f2cdd3ff3ba4acddeabd3a1d007141b690389af7f807d48de5f0"
},
"downloads": -1,
"filename": "ReplicantDriveSim-0.4.7.tar.gz",
"has_sig": false,
"md5_digest": "bee1115dc3292b6bd4d2dc9c229266b2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 91553981,
"upload_time": "2024-10-22T23:32:11",
"upload_time_iso_8601": "2024-10-22T23:32:11.049977Z",
"url": "https://files.pythonhosted.org/packages/4e/fa/f14a7be80c19f7ad1769778b2be5b0691914a8d095d6c42f2b0e84c2309d/ReplicantDriveSim-0.4.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 23:32:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "replicantdrivesim"
}
JSON