source: trunk/adm/guides/get.xml @ 82

Last change on this file since 82 was 82, checked in by pinsard, 16 years ago

add superbib_profile.sh (not yet for end users)
File size: 8.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE article [
3<!ENTITY % isolat1 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat1.ent">
4%isolat1;
5<!ENTITY % isolat2 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat2.ent">
6%isolat2;
7<!ENTITY % isogrk3 SYSTEM "http://www.w3.org/2003/entities/iso8879/isogrk3.ent">
8%isogrk3;
9<!ENTITY % isopub SYSTEM "http://www.w3.org/2003/entities/iso8879/isopub.ent">
10%isopub;
11<!ENTITY % isotech SYSTEM "http://www.w3.org/2003/entities/iso8879/isotech.ent">
12%isotech;
13<!ENTITY % isonum SYSTEM "http://www.w3.org/2003/entities/iso8879/isonum.ent">
14%isonum;
15<!ENTITY project "SUPERBIB">
16<!ENTITY project_svn "superbib">
17]>
18<article version="5.0"
19xmlns="http://docbook.org/ns/docbook"
20xmlns:xl="http://www.w3.org/1999/xlink"
21xmlns:xi="http://www.w3.org/2001/XInclude"
22xml:lang="en"
23xml:id="get">
24
25  <title>Get <application>&project;</application></title>
26
27  <info>
28   <pubdate>$Id$</pubdate>
29  </info>
30
31
32  <sect1 xml:id="create_env">
33    <title> Create <application>&project;</application> environment </title>
34    <para>
35      To simplify the explanation, we suppose that we install <application>&project;</application> in your <filename class='directory'>${HOME}/&project;_ws/</filename> (<quote>ws</quote> for <quote>working space</quote>).
36    </para>
37    <para>
38      <screen>
39  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput>
40  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>&project;_ws/</parameter></userinput>
41      </screen>
42    </para>
43  </sect1>
44
45
46 <sect1 xml:id="get_files">
47    <title> Get <application>&project;</application> files </title>
48
49
50    <sect2 xml:id="local">
51      <title> If you work on LOCEAN systems</title>
52      <para>
53The latest operation release <application>&project;</application> is already installed at
54<itemizedlist>
55  <listitem>
56           <simpara>LOCEAN: <filename class='directory'>/usr/home/fplod/&project;_DIR</filename>
57           </simpara>
58         </listitem>
59</itemizedlist>
60If you can access one of these directories, there is no need to re-install <application>&project;</application> again! In that case, you only have to link <filename class='directory'>${HOME}/&project;_DIR</filename> to the appropriate directory:
61<variablelist>
62  <varlistentry><term>LOCEAN</term>
63  <listitem><screen>
64  <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/usr/home/fplod/&project;_DIR</parameter> <parameter>${HOME}/&project;_DIR</parameter></userinput>
65  </screen>
66           </listitem>
67  </varlistentry>
68</variablelist>
69      </para>
70    </sect2>
71
72
73    <sect2 xml:id="svn">
74      <title> If <link xl:href="http://subversion.tigris.org/"><application> Subversion (svn)</application></link> client is installed on your machine </title>
75      <sect3 xml:id="svn_users">
76<title> Regular users </title>
77      <para>
78The <emphasis role="bold">complete</emphasis> latest revision (source + tests data files: &szallsvn; Mb) can be checked out with the following command executed in your <envar>${HOME}</envar>:
79<screen>
80  <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/svn/trunk/</parameter> <parameter>&project;_DIR</parameter></userinput>
81</screen>
82      </para>
83      <para>
84The latest revision of the <emphasis role="bold">source files</emphasis> (&szsrcsvn; Mb) can be checked out with the following command:
85<screen>
86  <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/svn/trunk/SRC</parameter> <parameter>&project;_DIR/SRC</parameter></userinput>
87</screen>
88      </para>
89      <para>
90The latest revision of the <emphasis role="bold">NetCDF data files</emphasis> (&szdatasvn; Mb) used by the test programs can be checked out with the following command:
91<screen>
92  <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/svn/trunk/DATA</parameter> <parameter>&project;_DIR/DATA</parameter></userinput>
93</screen>
94      </para>
95      </sect3>
96      <sect3 xml:id="svn_contributors">
97<title> Contributors </title>
98      <para>
99<emphasis role="bold">Contributors</emphasis> should better use the following command (and replace login by their own login):
100<screen >
101  <prompt>$</prompt> <userinput><command>svn</command> <option>checkout</option> <parameter>svn+ssh://<replaceable>login</replaceable>@forge.ipsl.jussieu.fr/ipsl/forge/projets/&project_svn;/svn/trunk/</parameter> <parameter>&project;_DIR</parameter></userinput>
102</screen>
103      </para>
104      </sect3>
105    </sect2>
106
107
108    <sect2 xml:id="tar">
109      <title> Get <application>&project;</application> from a tar file </title>
110      <sect3 xml:id="src_tar">
111<title> Get <application>&project;</application> source files (&szsrc; Mb) </title>
112<para>
113  Create your <filename class='directory'>${HOME}/&project;_DIR</filename> directory &hellip;
114  <screen>
115  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput>
116  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>&project;_DIR</parameter></userinput>
117  <prompt>$</prompt> <userinput><command>cd</command> <parameter>&project;_DIR</parameter></userinput>
118  </screen>
119         </para>
120         <para>
121  &hellip; and download it the latest version of the sources tar file: <link xl:href="http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_SRC_&date;.tar.gz">&project;_SRC_&date;.tar.gz</link> (&szsrc; Mb).
122</para>
123<para>
124This tar.gz file could also be downloaded with <command>wget</command> or <command>curl</command>
125<variablelist>
126  <varlistentry><term><command>wget</command></term>
127  <listitem><screen>
128  <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_SRC_&date;.tar.gz</parameter></userinput>
129  </screen>
130           </listitem>
131  </varlistentry>
132  <varlistentry><term><command>curl</command></term>
133  <listitem><screen>
134  <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_SRC_&date;.tar.gz</parameter></userinput>
135  </screen>
136           </listitem>
137  </varlistentry>
138</variablelist>
139Untar the file
140<screen>
141  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}/&project;_DIR</parameter></userinput>
142  <prompt>$</prompt> <userinput><command>tar</command> <option>xvfz</option> <parameter>&project;_SRC_&date;.tar.gz</parameter></userinput>
143  <prompt>$</prompt> <userinput><command>rm</command> <parameter>&project;_SRC_&date;.tar.gz</parameter></userinput>
144</screen>
145</para>
146
147      </sect3>
148      <sect3 xml:id="data_tar">
149<title> Get <application>&project;</application> tests data files (&szdata; Mb) </title>
150<para>
151If you want to use the tests programs, you need to download the data tests files (<filename>&project;_DATA_&date2;.tar.gz</filename>), you may download theses files in
152<itemizedlist>
153  <listitem>
154           <simpara><filename class='directory'>${HOME}/My_IDL</filename>. This is the easiest solution but it could be inconvenient if your <envar>${HOME}</envar> disk space is limited.
155           </simpara>
156          </listitem>
157</itemizedlist>
158<screen>
159  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput>
160  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput>
161  <prompt>$</prompt> <userinput><command>cd</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput>
162</screen>
163Download <link xl:href="http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz">&project;_DATA_&date2;.tar.gz</link> (&szdata; Mb)
164or with <command>wget</command> or <command>curl</command> &hellip;
165<variablelist>
166  <varlistentry><term><command>wget</command></term>
167  <listitem><screen>
168  <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz</parameter></userinput>
169   </screen>
170           </listitem>
171  </varlistentry>
172  <varlistentry><term><command>curl</command></term>
173  <listitem><screen>
174  <prompt>$</prompt> <userinput><command>curl</command> <option>-O</option> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz</parameter></userinput>
175  </screen>
176            </listitem>
177  </varlistentry>
178</variablelist>
179</para>
180      </sect3>
181    </sect2>
182  </sect1>
183<sect1 xml:id="afterget">
184<title>After this</title>
185<para>
186You are now ready to do your
187<link xl:href="./firststeps.html">First steps with &project;</link>.
188</para>
189</sect1>
190</article>
Note: See TracBrowser for help on using the repository browser.