Download Source Code

This page explain how to download the source code from 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 enabled to use OSParticulas, you will get separate instructions for downloading the 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

For a public, anonymous checkout of nairn-mpm-fea, use the command line:

svn checkout http://nairn-mpm-fea.googlecode.com/svn/trunk/ nairn-mpm-fea-read-only

Here nairn-mpm-fea-read-only is the name of the folder that will be created with the checked out code. You can use any name you want.

Password Enabled Checkout

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 checkout with a username and password. But first, you need a password. The process is:

1. Participating in any googlecode.com project requires a google account and a gmail email addess. If you do not have one, you can create one for free at http://www.google.com. If you already have a google account, you can easily add an email address, if needed.
2. Email your google gmail address to John Nairn with a request to be a committer (ability to make changes) or a contributer (to be added as a visible user of the code). You will be emailed back when you have been added to the project.
3. Once you hear back sign in to your google account and find your profile in the googlecode.com section. The "My Profile" tab will show your username (from your gmail address) and the "Settings" tab will show your googlecode.com password. Make of note of this generated password, because it is (sometimes) needed for the checkout.

These above steps only need to be done once. Once they are done, you can use svn to check out a copy of the project with:

svn checkout https://nairn-mpm-fea.googlecode.com/svn/trunk/ nairn-mpm-fea --username YOURUSERNAME

or if SSL connection is not enabled, you can instead use

svn checkout http://nairn-mpm-fea.googlecode.com/svn/trunk/ nairn-mpm-fea --username YOURUSERNAME

Here nairn-mpm-fea is the name of the folder that will be created with the checked out code. You can use any name you want. Also YOURUSERNAME is the username you obtained in step #3 above. After giving this command, you may need to enter the password from step #3 to finish the checkout.

Checkout Project Versions

Occasionally the main trunk or development branches may have issues. To help avoid such issues, various complete releases are tagged and can be checked out instead while waiting for main trunk to reach a stable condition. Sometimes while developing, you may need to compare to previous revision numbers or versions on 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:

svn checkout http://nairn-mpm-fea.googlecode.com/svn/tags/release-1.0 nairn-mpm-fea-1.0

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:

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

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 svn 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 partial list that can be used to locate which revisions changed the source code.

Checkout a Branch

From time to time, nairn-mpm-fea will use branches, such as to work on special features or as a coding area for project committers working on their own code features. To check out a branch using a password (which is most common), use:

svn checkout https://nairn-mpm-fea.googlecode.com/svn/branches/branch_name \
          nairn-mpm-fea-branch_name --username YOURUSERNAME

where branch_name is the name of the branch (if https does not work, use http instead).