SU2 News

SU2 logo

SU2 source code now available on GitHub!

by Aniket C. Aranake

The development team is proud to announce that SU2 has moved to GitHub!

This change makes it much easier for individuals and groups to use and modify the code for their own purposes. It also means that from now on we'll be using Git, a more powerful and flexible concurrent versions system than the previously used SVN.

Users who wish to work with the code will now find that all of the capabilities they require to track modifications are already in place. Copying the code and submitting revisions is easier than ever with GitHub's "fork" and "pull request" features.

To illustrate the usage of GitHub with SU2, suppose a member of a research lab requires to modify SU2 for his particular application. By signing up for a GitHub account, he may create a "fork" of the master repository. This copies the contents of the master repository into the user's personal GitHub account. From there, he may use the Git versioning system system to download a local copy of the code. Upon modification, he can save his changes by pushing them back to his GitHub account. Access to the forked repository is controlled by the user, and he can grant access to members of his lab or other associates to his fork so that they may work on the new feature collaboratively.

Once a new feature is completed and is working well, if the user wishes to share his contributions to the main repository (and we hope you would!) he may do so by submitting a "pull request." This feature of GitHub alerts the SU2 development team that a new feature has been added and should be merged into the main repository. A member of the development team will review and handle the details of the merge.

Moving to GitHub is an important and exciting step for SU2. As lead developer Francisco Palacios said in a recent message to the developer's mailing list, "After the GutHub migration, there is clear speed up in the SU2 development."

For more information about Git and GitHub, visit www.github.com. To view the SU2 repository, visit https://github.com/su2code/SU2.

For further information, please visit: su2.stanford.edu

back to news >>