Difference between revisions of "Download Source Code"

From OSUPDOCS
Jump to navigation Jump to search
Line 1: Line 1:
= Introduction =
This page explain how to download the source code from <tt>googlecode.com</tt>.
 
== Introduction ==


You must use Subversion (or <tt>svn</tt>) on your local computer to download the entire <tt>nairn-mpm-fea</tt> project from <tt>googlecode.com</tt>. The <tt>svn</tt> 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 [[Windows Setup|set up <tt>cygwin</tt>]] and use its version of <tt>svn</tt>. In each platform there may by other <tt>svn</tt> options as well, but this page is based on the command-line approach.
You must use Subversion (or <tt>svn</tt>) on your local computer to download the entire <tt>nairn-mpm-fea</tt> project from <tt>googlecode.com</tt>. The <tt>svn</tt> 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 [[Windows Setup|set up <tt>cygwin</tt>]] and use its version of <tt>svn</tt>. In each platform there may by other <tt>svn</tt> options as well, but this page is based on the command-line approach.


Once you have <tt>svn</tt> installed, you can either do an [[#Anonymous Checkout|anonymous checkout]] or a [[#Password Enabled Checkout|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 [[Project Versions|download a stable prior version instead]]. It is also possible various development version will be available by [[Checkout a Branch|checking out a branch]] instead of the main trunk.
Once you have <tt>svn</tt> installed, you can either do an [[#Anonymous Checkout|anonymous checkout]] or a [[#Password Enabled Checkout|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 [[Project Versions|checkout a stable prior version instead]]. It is also possible various development versions will be available by [[#Checkout a Branch|checking out a branch]] instead of the main trunk.


=Anonymous Checkout=
==Anonymous Checkout==


For a public, anonymous checkout of `nairn-mpm-fea`, use the command line:
For a public, anonymous checkout of <tt>nairn-mpm-fea</tt>, use the command line:


{{{
svn checkout http://nairn-mpm-fea.googlecode.com/svn/trunk/ nairn-mpm-fea-read-only
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.
Here <tt>nairn-mpm-fea-read-only</tt> is the name of the folder that will be created with the checked out code. You can use any name you want.


Once you have the code, open the `index.html` file in the Documentation folder to learn how to compile all code, run calculations, and visualize the results.
==Password Enabled Checkout==


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


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:
# Participating in any <tt>googlecode.com</tt> 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.
# Email your google gmail address to John.Nairn@oregonstate.edu 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.
# Once you hear back sign in to your google account and find your profile in the <tt>googlecode.com</tt> section. The "My Profile" tab will show your username (from your gmail address) and the "Settings" tab will show your <tt>googlecode.com</tt> password. Make of note of this generated password, because it is (sometimes) needed for the checkout.


  # 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 <a href="http://www.google.com">`google.com`</a>. If you already have a google account, you can easily add an email address, if needed.
These above steps only need to be done once. Once they are done, you can use <tt>svn</tt> to check out a copy of the project with:
  # Email you google gmail address to `<John.Nairn@oregonstate.edu>` 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.
  # Once you hear back sign in to your google account and find your profile in the `GoogleCode.com` section. The "My Profile" tab there 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 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


{{{
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
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
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 will need to enter the password from step #3 to finish the checkout.


Once you have the code, open the `index.html` file in the Documentation folder to learn how to compile all code, run calculations, and visualize the results.
Here <tt>nairn-mpm-fea</tt> is the name of the folder that will be created with the checked out code. You can use any name you want. Also <tt>YOURUSERNAME</tt> 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 a Branch=
==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:
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:

Revision as of 15:42, 24 May 2013

This page explain how to download the source code from googlecode.com.

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@oregonstate.edu 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 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).