gymfc
A universal flight control tuning framework
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- bug_fix.md
- feature_change.md
- pull_request_template.md
- Dockerfile
- Dockerfile
- pid.py
- README.md
- ZieglerNichols.py
- __init__.py
- base.py
- continuous.py
- delta.py
- ramp.py
- reference.py
- rewards.py
- states.py
- step.py
- __init__.py
- baselinespolicy.py
- graphpolicy.py
- pbpolicy.py
- pidpolicy.py
- policy.py
- README.md
- battery_tattu_rline_1550mah.fcstd
- fc_stack_simple.FCStd
- floss2_frame.fcstd
- motor_hyperlite_2204_2522.fcstd
- battery_tattu_rline_1550mah.dae
- battery_tattu_rline_1550mah.stl
- fc_stack_simple.dae
- fc_stack_simple.stl
- frame_floss2.dae
- frame_floss2.stl
- motor_hyperlite_2204_2522.dae
- motor_hyperlite_2204_2522.stl
- prop_gemfan_5152R_ccw.dae
- prop_gemfan_5152R_ccw.stl
- prop_gemfan_5152R_cw.dae
- prop_gemfan_5152R_cw.stl
- model.config
- model.sdf
- README.md
- log.py
- monitor.py
- __init__.py
- pid_example.py
- plot_flight.py
- plot_flight_metrics.py
- ppo_baselines_train.py
- README.md
- setup.py
- tf_checkpoint_evaluate.py
- model.config
- model.sdf
- Action.proto
- EscSensor.proto
- Float.proto
- Imu.proto
- MotorCommand.proto
- State.proto
- AircraftConfigPlugin.cpp
- build_plugin.sh
- CMakeLists.txt
- FlightControllerPlugin.cpp
- FlightControllerPlugin.hh
- README.md
- attitude.world
- empty.world
- __init__.py
- fc_env.py
- __init__.py
- Action_pb2.py
- State_pb2.py
- __init__.py
- plot.py
- __init__.py
- gymfc.ini
- gymfc-logo.png
- gymfc-vis.png
- gymfc2-arch.png
- gymfc2.png
- pid-step-AttFC_GyroErr-MotorVel_M4_Con-v0.png
- pid-step-AttFC_GyroErr-MotorVel_M4_Ep-v0.png
- check_sim_stability.py
- dyno.py
- README.md
- test_axis.py
- test_start_sim.py
- test_step_sim.py
- .all-contributorsrc
- .gitignore
- .gitmodules
- .travis.yml
- CONTRIBUTING.md
- gen_pb.sh
- install_dependencies.sh
- LICENSE.txt
- README.md
- setup.py
# Installation Guide
git clone https://github.com/wil3/gymfc
Downloads the entire project code from GitHub to your computer.
cd gymfc
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Python 3 Python is required to use pip.
pip3 install .
Installs the package published on PyPI directly โ no need to clone the source.
Pulled directly from this repo's README.
3. Docker
Easy- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
This repository includes an experimental docker build in `docker/demo` that demos the usage of GymFC.
Builds a runnable image based on the Dockerfile.
has not been verified to work for Ubuntu. This docker image can help ensure you
Type this command into your terminal and run it.
For Mac, install [Docker for Mac](https://docs.docker.com/docker-for-mac/install/) and [XQuartz](https://www.xquartz.org/) on your system.
Type this command into your terminal and run it.
For Ubuntu, install [Docker for Ubuntu](https://docs.docker.com/engine/install/ubuntu/).
Type this command into your terminal and run it.
Build the docker image
Type this command into your terminal and run it.
Pulled directly from this repo's README.
4. CMake
Mediumcd gymfc/envs/assets/gazebo/plugins
This project's files live in a subfolder, so move into it first.
mkdir build && cd build
Creates a folder to hold the build output and moves into it.
cmake ..
Analyzes the source code and generates build configuration files (must be run inside the build folder).
make
Compiles the code based on the generated build configuration to produce an executable.
5. Python
Easypip3 install .
Installs the package published on PyPI directly โ no need to clone the source.
pip3 install -e .
Installs the Python libraries listed in requirements.txt (or similar).
Pulled directly from this repo's README.