Skip to content

loydhook/openGCAS-someDocsChanges

 
 

Repository files navigation

openGCAS - open Ground Collision Avoidance System

Coveralls GitHub GitHub (Pre-)Release GitHub (Pre-)Release Date GitHub commits since latest release

openGCAS is an open source aviation safety system designed to help aircraft avoid flight into the ground or terrain. openGCAS works by evaluating current aircraft state information, predicting a possible escape trajectory, comparing the altitude of that trajecotry to the altitude of the ground at that location, and evaluating the results. If the trajectory is found to come too close to the terrain at any point in the predicted trajectory, openGCAS commands an avoidance manuver to be preformed. openGCAS was created to help save the hundreds of pilots and passengers that die every year from this type of accident.

Please see the Documentation for more detailed information.

1. Features

TODO = listing of the most important features of the software openGCAS -

2. Directory and File Structure of this Repository

2.1 Directories

Directory Content
.github/workflows GitHub Action workflows.
data Non-source files, like INI files.
docs Documentation files.
include Public headers.
src Source files and private headers.
tests Test cases.

2.2 Files

File Functionality
.gitignore Configuration of files and folders to be ignored.
CMakeList.txt CMake configuration file.
Dockerfile Docker image configuration file.
LICENSE.md Text of the licence terms.
MakefileDocs Definition of documentation task to be excuted with the make command.
mkdocs.yml Configuration file for MkDocs.
Pipfile Definition of the Python package requirements.
Pipfile.lock Definition of the specific versions of the Python packages.
README.md This file.

2.3 Build and run (docker ubuntu:focal)

docker build -t faa_vail_opengcas:latest .
docker run --rm -it faa_vail_opengcas:latest

3. Support

If you need help with openGCA, do not hesitate to get in contact with us!

  • For questions and high-level discussions, use Discussions on GitHub.
  • To report a bug or make a feature request, open an Issue on GitHub.

Please note that we may only provide support for problems / questions regarding core features of openGCA. Any questions or bug reports about features of third-party themes, plugins, extensions or similar should be made to their respective projects. But, such questions are not banned from the Discussions.

Make sure to stick around to answer some questions as well!

4. Links

5. Contributing to openGCA

The openGCA project welcomes, and depends on, contributions from developers and users in the open source community. Please see the Contributing Guide for information on how you can help.

6. Code of Conduct

Everyone who interacts in the openGCA project's codebase, issue trackers, and discussion forums is expected to follow the Code of Conduct.

7. License

GNU LESSER GENERAL PUBLIC LICENSE

About

Ground Collision Avoidance System

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 88.2%
  • CMake 6.0%
  • Dockerfile 4.2%
  • C 1.6%