.all-contributorsrc

@@ -0,0 +1,76 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "wil3",
+      "name": "Wil Koch",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/4587660?v=4",
+      "profile": "https://wfk.io",
+      "contributions": [
+        "code",
+        "doc",
+        "example",
+        "infra"
+      ]
+    },
+    {
+      "login": "MichaelManz",
+      "name": "Michael Friedrich",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/1280036?v=4",
+      "profile": "https://github.com/MichaelManz",
+      "contributions": [
+        "code",
+        "example",
+        "infra"
+      ]
+    },
+    {
+      "login": "sidmysore",
+      "name": "Sid Mysore",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/12174271?v=4",
+      "profile": "https://github.com/sidmysore",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "SwapnilPande",
+      "name": "Swapnil Pande",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/9200948?v=4",
+      "profile": "https://github.com/SwapnilPande",
+      "contributions": [
+        "bug",
+        "ideas",
+        "test"
+      ]
+    },
+    {
+      "login": "xabierolaz",
+      "name": "xabierolaz",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/31626226?v=4",
+      "profile": "https://github.com/xabierolaz",
+      "contributions": [
+        "test"
+      ]
+    },
+    {
+      "login": "varunag18",
+      "name": "varunag18",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/1232584?v=4",
+      "profile": "https://github.com/varunag18",
+      "contributions": [
+        "test"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "gymfc",
+  "projectOwner": "wil3",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### Prerequisites
+* [  ] Put an X between the brackets on this line to verify you have done the following:
+    * I have checked that your issue isn't already filed.
+    * I am running Ubuntu 18.04
+    * I installed the environment and GymFC according to these [instructions](https://github.com/wil3/gymfc/#quick-start). 
+
+### Description
+A clear and concise description of what the bug is.
+
+### Steps to Reproduce
+Provide the list of commands and the corresponding output. **Do not** post output as images/screenshots. Place output in a fenced [code block](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks). Images are not searchable thus preventing others from finding similar issues and they are difficult to read. 
+1. Execute command X
+```
+Output from command X
+```
+2. Execute command Y
+```
+Output from command Y
+```
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/bug_fix.md

@@ -0,0 +1,14 @@
+### Requirements for Contributing a Bug Fix
+* Read
+  [CONTRIBUTING.md](https://github.com/wil3/gymfc/blob/master/CONTRIBUTING.md)
+* The pull request must only fix an existing bug. To contribute other changes, you must use a different template.
+* Open an issue. Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.
+* Fill out the template below, any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
+
+### Identify the Bug
+
+Closes: #XXX
+
+### Description of the Change
+
+### Verification and Validation of the Change

.github/PULL_REQUEST_TEMPLATE/feature_change.md

@@ -0,0 +1,29 @@
+### Requirements for Adding, Changing, or Removing a Feature
+* Read
+  [CONTRIBUTING.md](https://github.com/wil3/gymfc/blob/master/CONTRIBUTING.md)
+* Open an issue. Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.
+* Fill out the template below, any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
+
+### Description of the Change
+
+Closes: #XXX
+
+<!--
+
+We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
+
+-->
+
+### Verification Process
+
+<!--
+
+What process did you follow to verify that your change has the desired effects?
+
+- How did you verify that all new functionality works as expected?
+- How did you verify that all changed functionality works as expected?
+- How did you verify that the change has not introduced any regressions?
+
+Describe the actions you performed (commands you ran, etc.), and describe the results you observed.
+
+-->

.github/pull_request_template.md

@@ -0,0 +1,27 @@
+### Requirements for Pull Request
+* Read [CONTRIBUTING.md](https://github.com/wil3/gymfc/blob/master/CONTRIBUTING.md).
+* Open an issue. Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.
+* Fill out the template below, any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
+
+### Description of the Change
+
+Closes: #XXX
+
+<!--
+
+We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
+
+-->
+
+### Verification Process
+<!--
+
+What process did you follow to verify that your change has the desired effects?
+
+- How did you verify that all new functionality works as expected?
+- How did you verify that all changed functionality works as expected?
+- How did you verify that the change has not introduced any regressions?
+
+Describe the actions you performed (commands you ran, etc.), and describe the results you observed.
+
+-->

.gitignore

@@ -3,7 +3,12 @@
 **/.gazebo/*
 **/.sdformat/*
 **/.config/*
+**/build
 Makefile
 *.cmake
 CMakeCache.txt
 **/CMakeFiles/*
+.vimrc
+gymfc.json
+.idea
+env/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "modules/control/pid/ivPID"]
+	path = modules/control/pid/ivPID
+	url = https://github.com/ivmech/ivPID

.travis.yml

@@ -0,0 +1,16 @@
+# This travis script builds and installs gymfc via pip in a docker container. 
+# We need the docker container because we want to use the same running environment 
+# for the build and this can take over an hour exceeding the travis build timeout. 
+sudo: required
+language: generic
+matrix:
+  include:
+  - name: "Bionic beaver"
+    dist: bionic
+services:
+  - docker
+before-install:
+  - docker pull wil3/gymfc:testing
+install:
+  - docker run -v $TRAVIS_BUILD_DIR:/tmp/gymfc wil3/gymfc:testing "cd /tmp/gymfc && pip3 install ."
+

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to GymFC
+
+:+1::tada: Thank you for wanting to contribute to GymFC! :+1::tada: 
+
+Together we can build next
+generation flight control systems :rocket: :airplane: :helicopter: and there are many ways you can help! 
+
+## Bug reporting
+Please follow these steps when reporting a bug.
+
+1) Search through the issues to ensure your bug has not already been submitted. 
+2) Open a new issue and describe at lengths how the bug can be reproduced.
+3) Include the full verbose output in markdown
+code block, not as an image. Images can't be searched.
+
+## Code Contributions
+Please follow these steps in order to have your contribution considered by
+the maintainers.
+
+1) Search through the issues to verify your code changes have not already been
+discussed. 
+2) Open an issue on Github outlining the changes you would like to make. Scope
+each issue to a single change (i.e., improvement to the documentation, a bug fix,
+ a new feature, etc.). If there are multiple changes you'd like to
+propose,  please open an new issue for each one. The issue serves as the location for discussing and
+documenting the change to be made.  Once the change is approved continue to the
+next step.
+2) If you haven't already done so, fork the gymfc repository.
+2) Create a branch named `i[issue number]-brief-description` where `[issue
+number]` is the issue number previously created and `brief-description` is a
+brief description of the change you are making. For example `i45-contribution`.
+
+3) Make changes on your new branch, follow the style guide below. Test you code changes. Double check your commits to ensure unnecessary commits are not being made to keep the commit history clean. 
+
+4) When you are happy with the code changes open up a pull request. Specify the
+issue the PR closes, for example `Closes: #45`. When the PR is merged, this keyword will automatically close the corresponding issue. 
+Please provide testing results that will affect your code changes. A number of
+testing scripts already exist in /test that may help. 
+
+## R&D
+
+We are always in need of better models and reward functions.  
+
+## Documentation and Examples
+
+It can be intimidating getting into this research, it is very
+multi-disciplinary. Good documentation allows for more people to get involved.  
+
+## Style Guides 
+
+### Git messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+
+### Code
+
+We adhere to Google's style guide for Python code.
+The Python guide can be found
+[here](http://google.github.io/styleguide/pyguide.html). 
+
+To stay consistent with Gazebo, the Gazebo C++ plugins follow the Gazebo style guide found
+[here](http://gazebosim.org/tutorials?tut=contrib_code&cat=development).
+
+## Add your self as a contributor
+GymFC uses the [all-contributors bot](https://allcontributors.org/docs/en/bot/overview) to maintain a list of all contributors. When you open a PR be sure to add your self as a contributor using the bot usage [here](https://allcontributors.org/docs/en/bot/usage).