Difference between revisions of "Download Source Code"

Revision as of 10:09, 14 August 2015

This page explain how to download source code from the nairn-mpm-fea project on googlecode.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

You must use Subversion (or svn) on your local computer to download the entire nairn-mpm-fea project from googlecode.com. The svn package is available for Mac and Linux as a command-line tool (see http://subversion.tigris.org/ if you need to install it). For Windows, one solution is to set up cygwin and use its version of svn. In each platform there may by other svn options as well, but this page is based on the command-line approach.

Once you have svn installed, you can either do an anonymous checkout or a password enabled check. Both these methods listed below get the current main trunk version. To get older versions (in case current main trunk version has issues), you can checkout a stable prior version instead. It is also possible various development versions will be available by checking out a branch instead of the main trunk.

Anonymous Checkout

This project is now hosted on Github. It was moved there on August 14, 2015 because Google Code terminated development options on August 25, 2015. 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 use other clone methods as well.

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.

Working with Branches

When you clone the Github project, you have a complete copy of the nairn-mpm-fea project repository. You can use standard Git methods to choose which branch to work on. You can also easily create your own branches. You can refer to Git documentation for details.

@@ Line 21: / Line 21: @@
 If you might want to contribute changes to the <tt>nairn-mpm-fea</tt> 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 [https://github.com GitHub], fork this project, make changes, and then submit a pull request. More details are given in the [https://help.github.com/articles/fork-a-repo/ GitHub help files].
-== Checkout Project Versions and Branches ==
+==Work on Project Versions and Branches==
 When using Git, you have a complete copy on the <tt>nairn-mpm-fea</tt> 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.
-Occasionally the main trunk or development branches may have issues. To help avoid such issues, various complete releases are tagged and can be [[#Checkout a Tagged Version|checked out]] instead while waiting for main trunk to reach a stable condition. Sometimes while developing, you may need to compare to previous [[#Checkout by Version Number or Date|revision numbers]] or versions on [[#Checkout by Version Number or Date|specific dates]]. Such comparisons can help diagnosis bugs that have been introduced at some point in time.
-====Checkout Out a Tagged Version====
-To check out a tagged release instead of the current development release, simply change the path in the checkout command. For example, an anonymous check out would be:
- <pre>svn checkout http://nairn-mpm-fea.googlecode.com/svn/tags/release-1.0 nairn-mpm-fea-1.0</pre>
-where the final component in the path is the version you want. See [[Tagged Versions]] for a list of available tagged releases.
-====Checkout by Version Number or Date====
-In addition to tagged versions, you can revert to any revision number or to the version on any date with the follow check out commands:
- <pre>svn checkout --revision 185 http://nairn-mpm-fea.googlecode.com/svn/trunk nairn-mpm-fea-185
-svn checkout --revision {2010-05-11} http://nairn-mpm-fea.googlecode.com/svn/trunk \
-                             nairn-mpm-fea-2010-05-11</pre>
-Every change to the code makes a new revision number. You can look up revision numbers in the "Source" tab on http://code.google.com/p/nairn-mpm-fea. A checkout by date means the revision that was current on that date. You can add a time if several revisions were made that day. When an <tt>svn</tt> checkout by date finishes, it will report the revision number that you received. Using revision number when looking for changes is more efficient because you are sure things changed. Checking out versions on different dates will give identical code if no changes were made between those dates. Furthermore, many revisions differ only in comments or documentation and not in source code. Here is a [[Unique_MPM_Revisions |partial list]] that can be used to locate which revisions changed the source code.
 ==Working with Branches ==
 When you clone the [https://github.com/nairnj/nairn-mpm-fea Github project], you have a complete copy of the <tt>nairn-mpm-fea</tt> project repository. You can use standard Git methods to choose which branch to work on. You can also easily create your own branches. You can refer to Git documentation for details.