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

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE article [
<!ENTITY % isolat1 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat1.ent">
%isolat1;
<!ENTITY % isolat2 SYSTEM "http://www.w3.org/2003/entities/iso8879/isolat2.ent">
%isolat2;
<!ENTITY % isogrk3 SYSTEM "http://www.w3.org/2003/entities/iso8879/isogrk3.ent">
%isogrk3;
<!ENTITY % isopub SYSTEM "http://www.w3.org/2003/entities/iso8879/isopub.ent">
%isopub;
<!ENTITY % isotech SYSTEM "http://www.w3.org/2003/entities/iso8879/isotech.ent">
%isotech;
<!ENTITY % isonum SYSTEM "http://www.w3.org/2003/entities/iso8879/isonum.ent">
%isonum;
<!ENTITY project "SUPERBIB">
<!ENTITY project_svn "superbib">
]>
<article version="5.0"
xmlns="http://docbook.org/ns/docbook"
xmlns:xl="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:lang="en"
xml:id="get">

  <title>Get <application>&project;</application></title>

  <info>
   <pubdate>$Id$</pubdate>
  </info>


  <sect1 xml:id="create_env">
    <title> Create <application>&project;</application> environment </title>
    <para>
      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>).
    </para>
    <para>
      <screen>
  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput>
  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>&project;_ws/</parameter></userinput>
      </screen>
    </para>
  </sect1>


 <sect1 xml:id="get_files">
    <title> Get <application>&project;</application> files </title>


    <sect2 xml:id="local">
      <title> If you work on LOCEAN systems</title>
      <para>
The latest operation release <application>&project;</application> is already installed at
<itemizedlist>
  <listitem>
           <simpara>LOCEAN: <filename class='directory'>/usr/home/fplod/&project;_DIR</filename>
           </simpara>
         </listitem>
</itemizedlist>
If you can access one of this directory, 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:
<variablelist>
  <varlistentry><term>LOCEAN</term>
  <listitem><screen>
  <prompt>$</prompt> <userinput><command>ln</command> <option>-s</option> <parameter>/usr/home/fplod/&project;_DIR</parameter> <parameter>${HOME}/&project;_DIR</parameter></userinput>
  </screen>
           </listitem>
  </varlistentry>
</variablelist>
      </para>
    </sect2>


    <sect2 xml:id="svn">
      <title> If <link xl:href="http://subversion.tigris.org/"><application> Subversion (svn)</application></link> client is installed on your machine </title>
      <sect3 xml:id="svn_users">
<title> Regular users </title>
      <para>
The <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>:
<screen>
  <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>
</screen>
      </para>
      </sect3>
      <sect3 xml:id="svn_contributors">
<title> Contributors </title>
      <para>
<emphasis role="bold">Contributors</emphasis> should better use the following command (and replace login by their own login):
<screen >
  <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>
</screen>
      </para>
      </sect3>
    </sect2>


<!-- ++ not yet
    <sect2 xml:id="tar">
      <title> Get <application>&project;</application> from a tar file </title>
      <sect3 xml:id="src_tar">
<title> Get <application>&project;</application> source files (&szsrc; Mb) </title>
<para>
  Create your <filename class='directory'>${HOME}/&project;_DIR</filename> directory &hellip;
  <screen>
  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput>
  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter>&project;_DIR</parameter></userinput>
  <prompt>$</prompt> <userinput><command>cd</command> <parameter>&project;_DIR</parameter></userinput>
  </screen>
         </para>
         <para>
  &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).
</para>
<para>
This tar.gz file could also be downloaded with <command>wget</command> or <command>curl</command>
<variablelist>
  <varlistentry><term><command>wget</command></term>
  <listitem><screen>
  <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_SRC_&date;.tar.gz</parameter></userinput>
  </screen>
           </listitem>
  </varlistentry>
  <varlistentry><term><command>curl</command></term>
  <listitem><screen>
  <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>
  </screen>
           </listitem>
  </varlistentry>
</variablelist>
Untar the file
<screen>
  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}/&project;_DIR</parameter></userinput>
  <prompt>$</prompt> <userinput><command>tar</command> <option>xvfz</option> <parameter>&project;_SRC_&date;.tar.gz</parameter></userinput>
  <prompt>$</prompt> <userinput><command>rm</command> <parameter>&project;_SRC_&date;.tar.gz</parameter></userinput>
</screen>
</para>

      </sect3>
      <sect3 xml:id="data_tar">
<title> Get <application>&project;</application> tests data files (&szdata; Mb) </title>
<para>
If 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
<itemizedlist>
  <listitem>
           <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.
           </simpara>
          </listitem>
</itemizedlist>
<screen>
  <prompt>$</prompt> <userinput><command>cd</command> <parameter>${HOME}</parameter></userinput>
  <prompt>$</prompt> <userinput><command>mkdir</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput>
  <prompt>$</prompt> <userinput><command>cd</command> <parameter><replaceable>CHOSEN_DIR</replaceable></parameter></userinput>
</screen>
Download <link xl:href="http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz">&project;_DATA_&date2;.tar.gz</link> (&szdata; Mb)
or with <command>wget</command> or <command>curl</command> &hellip;
<variablelist>
  <varlistentry><term><command>wget</command></term>
  <listitem><screen>
  <prompt>$</prompt> <userinput><command>wget</command> <parameter>http://forge.ipsl.jussieu.fr/&project_svn;/download/&project;_DATA_&date2;.tar.gz</parameter></userinput>
   </screen>
           </listitem>
  </varlistentry>
  <varlistentry><term><command>curl</command></term>
  <listitem><screen>
  <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>
  </screen>
            </listitem>
  </varlistentry>
</variablelist>
</para>
      </sect3>
    </sect2>
-->
  </sect1>
<sect1 xml:id="afterget">
<title>After this</title>
<para>
You are now ready to do your
<link xl:href="./firststeps.html">First steps with &project;</link>.
</para>
</sect1>
</article>