Download Source Code

From OSUPDOCS
Revision as of 16:49, 13 September 2015 by Nairnj (talk | contribs) (→‎Introduction)
Jump to navigation Jump to search

This page explain how to download source code from the nairn-mpm-fea project on github.com. The single source code package contains NairnMPM, NairnFEA, and NairnFEAMPMViz. After this downloading step is completed, you can move on to documentation for compiling the code engines. If you are enabled to use OSParticulas, you will get separate instructions for downloading its source code package.

Introduction

This nairn-mpm-fea project is now hosted on Github. It was moved there on August 14, 2015 because Google Code terminated development options on August 25, 2015. You must use git on your local computer to clone the entire nairn-mpm-fea project from githib.com. You can also use the GitHub desktop app. Please see github.com for system-specific details and for installation of any needed tools.

Anonymous Checkout

To download the latest project, you can clone the nairn-mpm-fea repository using the following command lines:

cd 'Git Projects'
git clone https://github.com/nairnj/nairn-mpm-fea.git

The first line moves to a folder (assumed to be already created) and the second line clones the repository in a new folder called nairn-fea-mpm inside the "Git Project" folder. You are now ready to work with the source code.

You can also close use GitHub desktop application, if your computer is compatible with that application.

Contributing to the Project

If you might want to contribute changes to the nairn-mpm-fea project, including changes to documentation or the project's wiki pages, or if you just want to have a visible presence in use of the code, you should create your own account on GitHub, fork this project, make changes, and then submit a pull request. More details are given in the GitHub help files.

Work on Project Versions and Branches

When using Git, you have a complete copy on the nairn-mpm-fea repository. You can use standard Git methods to "checkout" the version or branch you want to work on. The details can be found in Git documentation.