Difference between revisions of "Download"

From Madagascar
Jump to navigation Jump to search
(→‎Current development version: new download procedure for developers)
 
(6 intermediate revisions by 2 users not shown)
Line 14: Line 14:
 
==Current development version==
 
==Current development version==
  
To download the most recent Madagascar source code, you need to have a [http://subversion.apache.org/ Subversion client] (<tt>svn</tt>) installed. If you want to download it read-only, run the following command:
+
You can access the most recent Madagascar source code at the [https://github.com/ahay/src GitHub repository]
 +
 
 +
===Cloning with Git===
 +
 
 +
To download the source repository using [https://git-scm.com/ Git], run
 
<pre>
 
<pre>
svn co <nowiki>http://svn.code.sf.net/p/rsf/code/trunk</nowiki> RSFSRC
+
git clone <nowiki>https://github.com/ahay/src</nowiki> RSFSRC
 
</pre>
 
</pre>
 +
 
Replace <tt>RSFSRC</tt> with the path where you want to put the Madagascar source code.
 
Replace <tt>RSFSRC</tt> with the path where you want to put the Madagascar source code.
If you are a Madagascar project contributor and you want to download it in read-write mode, use
 
<pre>
 
svn co \
 
--username=<your_sourceforge_username> \
 
svn+ssh://<your_sourceforge_username>@svn.code.sf.net/p/rsf/code/trunk \
 
RSFSRC
 
</pre>
 
  
 
Next, follow [[Installation|Installation instructions]] to install.
 
Next, follow [[Installation|Installation instructions]] to install.
  
You can also [http://rsf.svn.sourceforge.net/viewvc/rsf/trunk/ browse the Subversion repository].
+
===Checking out with Subversion===
  
===Updating===
+
To download the source repository using [http://subversion.apache.org/ Subversion], run
 +
<pre>
 +
svn co <nowiki>https://github.com/ahay/src/trunk</nowiki> RSFSRC
 +
</pre>
  
To update the Madagascar source code on your computer with the changes made by developers, <tt>cd</tt> to the directory where you placed the sources and run
+
After the initial check out, you can update the Madagascar source code on your computer with the changes made by developers: <tt>cd</tt> to the directory where you placed the sources and run
 
<pre>
 
<pre>
 
svn update
 
svn update
 
</pre>
 
</pre>
  
===Troubleshooting===
+
===SVN Troubleshooting===
 
    
 
    
*If, after running the <tt>svn co...</tt> command, nothing happens, no message, no return to the command line: you may be behind a proxy. This is especially likely if your computer is on a corporate Intranet.  To get past a proxy, you need to tell Subversion: (1) The IP number or URL of the proxy and (2) the port that will allow <tt>svn</tt> through &ndash; most likely 80, the standard HTTP port. Open your <tt>~/.subversion/servers</tt> file in a text editor. If this file does not exist, running any <tt>svn</tt> command (even an unsuccessful one, like the one above) will automatically create the file. In the <tt>[global]</tt> section, add the following lines, with your own proxy URL and port names instead of the dummy ones below:  
+
*If, after running the <tt>svn</tt> command, nothing happens, no message, no return to the command line: you may be behind a proxy. This is especially likely if your computer is on a corporate Intranet.  To get past a proxy, you need to tell Subversion: (1) The IP number or URL of the proxy and (2) the port that will allow <tt>svn</tt> through &ndash; most likely 80, the standard HTTP port. Open your <tt>~/.subversion/servers</tt> file in a text editor. If this file does not exist, running any <tt>svn</tt> command (even an unsuccessful one, like the one above) will automatically create the file. In the <tt>[global]</tt> section, add the following lines, with your own proxy URL and port names instead of the dummy ones below:  
 
<pre>http-proxy-host = www-proxy.yourcompany.com
 
<pre>http-proxy-host = www-proxy.yourcompany.com
 
http-proxy-port = 80
 
http-proxy-port = 80
 
</pre> Now your <tt>svn</tt> commands should work. You can find more details [http://subversion.tigris.org/faq.html#proxy in the Subversion documentation]. It would also be a good idea to set in your <tt>.bashrc</tt> or <tt>.cshrc</tt> the environment variable <tt>HTTP_PROXY</tt> to your adaptation of <pre>http://www-proxy.yourcompany.com:80</pre> so that input datasets for reproducible figures can be downloaded automatically when you need them.
 
</pre> Now your <tt>svn</tt> commands should work. You can find more details [http://subversion.tigris.org/faq.html#proxy in the Subversion documentation]. It would also be a good idea to set in your <tt>.bashrc</tt> or <tt>.cshrc</tt> the environment variable <tt>HTTP_PROXY</tt> to your adaptation of <pre>http://www-proxy.yourcompany.com:80</pre> so that input datasets for reproducible figures can be downloaded automatically when you need them.
 
*If you get a "is already a working copy for a different URL" error, this means you have an existing directory downloaded from another server. Run <tt>svn switch --relocate</tt> to switch servers.
 
  
 
*If you are using an old Linux distribution (e.g. RedHat 9), the version of Subversion included with your distribution may need to be updated to handle the secure URL (<nowiki>https://</nowiki>).  If <tt>svn</tt> complains about an "unrecognized URL scheme" (and you've given it the correctly formatted URL), then you need to update it.
 
*If you are using an old Linux distribution (e.g. RedHat 9), the version of Subversion included with your distribution may need to be updated to handle the secure URL (<nowiki>https://</nowiki>).  If <tt>svn</tt> complains about an "unrecognized URL scheme" (and you've given it the correctly formatted URL), then you need to update it.
Line 60: Line 59:
  
 
==Other packages==
 
==Other packages==
There are two other packages that might be useful in conjunction with RSF:
+
There are two other packages that might be useful in conjunction with Madagascar:
 
===Reproducible figures===
 
===Reproducible figures===
 +
 +
Using Git, run
 +
<pre>git clone <nowiki>https://github.com/ahay/figs</nowiki> $RSFROOT/share/madagascar/figs </pre>
 
    
 
    
Using Subversion, run  
+
Alternatively, using Subversion, run  
<pre>svn co http://svn.code.sf.net/p/rsf/code/figs $RSFROOT/share/madagascar/figs </pre>  
+
<pre>svn co <nowiki>https://github.com/ahay/figs/trunk</nowiki> $RSFROOT/share/madagascar/figs </pre>  
This installs a wide collection of more than 5,000 reproducible figures. It may take a long time to download and more than 6 Gb of disk space.
+
 
 +
This installs a wide collection of almost 8,000 reproducible figures. It may take a long time to download and about 15 Gb of disk space.
 
The figures are preserved with the purpose of regression testing whenever the software or the environment change.
 
The figures are preserved with the purpose of regression testing whenever the software or the environment change.
  
Line 71: Line 74:
 
<pre>sfbooklist command="scons lock" book</pre>
 
<pre>sfbooklist command="scons lock" book</pre>
  
===L<sup>A</sup>TEX package===
+
===LaTeX package===
 
    
 
    
[[SEGTeX]] is a LaTeX package for geophysical publications. It can be used with madagascar for writing [[Reproducible Documents|reproducible papers]].
+
[[SEGTeX]] is a LaTeX package for geophysical publications. It can be used with Madagascar for writing [[Reproducible Documents|reproducible papers]].

Latest revision as of 16:52, 27 July 2015

Fotolia 2043821 XS.jpg

You can choose to download either the latest stable release, or the current development version (frequently updated).

Stable release

Download the source code distribution from Sourceforge, then unpack the directory with

gunzip < madagascar-*.tar.gz | tar xvf -

or

bunzip2 < madagascar-*.tar.bz2 | tar xvf -

The bz2 file is a bit smaller, but takes longer to unpack.

Next, follow Installation instructions to install.

Current development version

You can access the most recent Madagascar source code at the GitHub repository

Cloning with Git

To download the source repository using Git, run

git clone https://github.com/ahay/src RSFSRC

Replace RSFSRC with the path where you want to put the Madagascar source code.

Next, follow Installation instructions to install.

Checking out with Subversion

To download the source repository using Subversion, run

svn co https://github.com/ahay/src/trunk RSFSRC

After the initial check out, you can update the Madagascar source code on your computer with the changes made by developers: cd to the directory where you placed the sources and run

svn update

SVN Troubleshooting

  • If, after running the svn command, nothing happens, no message, no return to the command line: you may be behind a proxy. This is especially likely if your computer is on a corporate Intranet. To get past a proxy, you need to tell Subversion: (1) The IP number or URL of the proxy and (2) the port that will allow svn through – most likely 80, the standard HTTP port. Open your ~/.subversion/servers file in a text editor. If this file does not exist, running any svn command (even an unsuccessful one, like the one above) will automatically create the file. In the [global] section, add the following lines, with your own proxy URL and port names instead of the dummy ones below:
http-proxy-host = www-proxy.yourcompany.com
http-proxy-port = 80

Now your svn commands should work. You can find more details in the Subversion documentation. It would also be a good idea to set in your .bashrc or .cshrc the environment variable HTTP_PROXY to your adaptation of

http://www-proxy.yourcompany.com:80

so that input datasets for reproducible figures can be downloaded automatically when you need them.

  • If you are using an old Linux distribution (e.g. RedHat 9), the version of Subversion included with your distribution may need to be updated to handle the secure URL (https://). If svn complains about an "unrecognized URL scheme" (and you've given it the correctly formatted URL), then you need to update it.
  • If you are behind a firewall, you may need to set up more variables in your file ~/.subversion/servers (check with your IT support for all the required variables to get past the proxy) as for example
[global]
http-proxy-host = proxy-host-company.site.corp 
http-proxy-port = 1111
http-proxy-username = Yourusernameforproxy
http-proxy-password = Yourpasswordforproxy 

It would be a good idea then to protect your file ~/.subversion/servers from being read by others.

Other packages

There are two other packages that might be useful in conjunction with Madagascar:

Reproducible figures

Using Git, run

git clone https://github.com/ahay/figs $RSFROOT/share/madagascar/figs 

Alternatively, using Subversion, run

svn co https://github.com/ahay/figs/trunk $RSFROOT/share/madagascar/figs 

This installs a wide collection of almost 8,000 reproducible figures. It may take a long time to download and about 15 Gb of disk space. The figures are preserved with the purpose of regression testing whenever the software or the environment change.

You can reproduce the figures (excluding those generated with proprietary data or additional software) by running scons lock in individual project directories or by going to RSFSRC and running

sfbooklist command="scons lock" book

LaTeX package

SEGTeX is a LaTeX package for geophysical publications. It can be used with Madagascar for writing reproducible papers.