Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hemumanju/nuplane
https://github.com/hemumanju/nuplane
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hemumanju/nuplane
- Owner: HemuManju
- License: apache-2.0
- Created: 2023-07-06T03:40:08.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-12T20:39:27.000Z (7 months ago)
- Last Synced: 2024-10-15T18:20:09.764Z (3 months ago)
- Language: Python
- Size: 2.06 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# NASA ULI Xplane Simulator
*(Screenshot for illustration purposes only.)*
Welcome to the NASA ULI Xplane Simulator! This project aims to develop a powerful and flexible flight simulator built on top of the XPlane platform.
## Table of Contents
- [NASA ULI Xplane Simulator](#nasa-uli-xplane-simulator)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Data Collector](#data-collector)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [License](#license)
## Features
- Realistic flight simulation powered by the XPlane platform.
- Data collector for capturing various flight parameters and events.
- OpenAI Gym interface for reinforcement learning experiments.
- Highly customizable simulation environment.
- Easy-to-use and well-documented codebase.
## Installation
1. Clone this repository to your local machine using:
```
git clone https://github.com/HemuManju/nasa-uli-xplane.git
```
2. Install the required dependencies:
```
pip install -r requirements.txt
```
3. Configure your XPlane installation and simulator settings as needed.
## Usage
1. Launch the simulator by running:
```
python main.py
```
If you want to run a particular block of code, replace the `skip` by `run`.
2. Explore the simulation environment, adjust settings, and start flying!
## Data Collector
The data collector module allows you to capture various flight data, including aircraft state, control inputs, and environmental conditions. This collected data can be used for analysis, visualization, or machine learning purposes.
To use the data collector, refer to the documentation in the `data_collector` directory.
## Contributing
We welcome contributions from the community to improve and expand this simulator project. If you're interested in contributing, please follow our [Contribution Guidelines](CONTRIBUTING.md).
## Code of Conduct
Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) when participating in our community. We strive to maintain a respectful and inclusive environment for everyone.
## License
This project is licensed under the [MIT License](LICENSE), which means you are free to use, modify, and distribute the code in your projects.
---
We hope you enjoy using the XPlane Simulator with Data Collector and OpenAI Gym Interface. Happy flying!