If you want to make changes to RCAIDE source, or contribute new functionalities back to the community, this is the page for you! RCAIDE is developed via GitHub, and this page will describe how to get started. There is also a list of open topics available for contribution if you’re looking for ideas to get started.

As a developer, you’ll want to fork RCAIDE to your personal account. This creates a copy of the whole RCAIDE repository, including all past versions, inside your GitHub account. Generally, you’ll want to start from the develop branch, but you can check with the developers if you think it would be more appropriate to work on a feature branch.

Development is done on separate branches. Basically, there are three types of branches.

RCAIDE merges new code contributions through pull requests. As you make changes to your copy of RCAIDE, you’ll upload them to your GitHub fork, and then when they’re ready for review you’ll submit them for merge via pull request.

Style Guide

RCAIDE is built on a slightly modified PEP8 style guide, with changes made to implement a data-oriented view of the code. To help support discovering code, the RCAIDE folder structure explicitly mirrors the package structure. The flexibility of the package structure is important, so in general, all objects live in their own file, with the same file name as the object name. To maintain a separation between Analysis and Data structures, there are often parallel package trees inside the main branches of the package, like RCAIDE.Methods.Aerodynamics and RCAIDE.Analysis.Aerodynamics. Where possible, the names of fields that live in the RCAIDE package are written out verbosely, avoiding jargon built on mathematical variable names or acronyms.

Downloading Dependencies

Below are the packages that RCAIDE expects in order to run the tutorial cases. These are pip, numpy, scipy, matplotlip, plotly, scikit-learn, sklearn, pandas, geopy and  kaleido. You can install the dependent packages separately in the terminal of your machine.

Alternatively, you can use a scientific python distribution like Anaconda. All the package dependencies like scipy and numpy will come pre-packaged and stuff will just work.

Download Instructions

Once you’ve downloaded the code and prepared the software requirements, you’re ready to install it into python!

This should print the file path to the RCAIDE package file in your trunk directory.

Some Notes