Changeset 378


Ignore:
Timestamp:
05/13/09 09:18:16 (16 years ago)
Author:
Mathieu Morlighem
Message:

updated doc

Location:
issm/trunk/doc
Files:
1 added
1 deleted
7 edited

Legend:

Unmodified
Added
Removed
  • issm/trunk/doc/index.html

    r180 r378  
    4545                                        <li><a href="website/doc_html/download.html" title="Download">Download</a></li>
    4646                                        <li><a href="website/doc_html/installation.html" title="Installation">Installation</a></li>
    47                                         <li><a href="website/doc_html/wiki.html" title="Developers Site">Developers Site</a></li>
     47                                        <li><a href="website/doc_html/quickstart.html" title="Quick start">Quick start</a></li>
     48                                        <li><a href="http://s383-rhat/trac/issm/" title="Developers Site">Developers Site</a></li>
    4849                                        <li><a href="website/doc_html/faq.html" title="FAQ">FAQ</a></li>
    4950                                </ul>
  • issm/trunk/doc/website/doc_html/about.html

    r11 r378  
    6363                                        <li><a href="download.html" title="Download">Download</a></li>
    6464                                        <li><a href="installation.html" title="Installation">Installation</a></li>
    65                                         <li><a href="wiki.html" title="Developers Site">Developers Site</a></li>
     65                                        <li><a href="quickstart.html" title="Quick start">Quick start</a></li>
     66                                        <li><a href="http://s383-rhat/trac/issm/" title="Developers Site">Developers Site</a></li>
    6667                                        <li><a href="faq.html" title="FAQ">FAQ</a></li>
    6768                                </ul>
  • issm/trunk/doc/website/doc_html/documentation.html

    r180 r378  
    3939                                        <li><a href="download.html" title="Download">Download</a></li>
    4040                                        <li><a href="installation.html" title="Installation">Installation</a></li>
    41                                         <li><a href="wiki.html" title="Developers Site">Developers Site</a></li>
     41                                        <li><a href="quickstart.html" title="Quick start">Quick start</a></li>
     42                                        <li><a href="http://s383-rhat/trac/issm/" title="Developers Site">Developers Site</a></li>
    4243                                        <li><a href="faq.html" title="FAQ">FAQ</a></li>
    4344                                </ul>
  • issm/trunk/doc/website/doc_html/download.html

    r11 r378  
    4646                                        <li><a href="download.html" title="Download">Download</a></li>
    4747                                        <li><a href="installation.html" title="Installation">Installation</a></li>
    48                                         <li><a href="wiki.html" title="Developers Site">Developers Site</a></li>
     48                                        <li><a href="quickstart.html" title="Quick start">Quick start</a></li>
     49                                        <li><a href="http://s383-rhat/trac/issm/" title="Developers Site">Developers Site</a></li>
    4950                                        <li><a href="faq.html" title="FAQ">FAQ</a></li>
    5051                                </ul>
  • issm/trunk/doc/website/doc_html/faq.html

    r11 r378  
    3434                                        <li><a href="download.html" title="Download">Download</a></li>
    3535                                        <li><a href="installation.html" title="Installation">Installation</a></li>
    36                                         <li><a href="wiki.html" title="Developers Site">Developers Site</a></li>
     36                                        <li><a href="quickstart.html" title="Quick start">Quick start</a></li>
     37                                        <li><a href="http://s383-rhat/trac/issm/" title="Developers Site">Developers Site</a></li>
    3738                                        <li><a href="faq.html" title="FAQ">FAQ</a></li>
    3839                                </ul>
  • issm/trunk/doc/website/doc_html/features.html

    r11 r378  
    2929                                        <li><a href="download.html" title="Download">Download</a></li>
    3030                                        <li><a href="installation.html" title="Installation">Installation</a></li>
    31                                         <li><a href="wiki.html" title="Developers Site">Developers Site</a></li>
     31                                        <li><a href="quickstart.html" title="Quick start">Quick start</a></li>
     32                                        <li><a href="http://s383-rhat/trac/issm/" title="Developers Site">Developers Site</a></li>
    3233                                        <li><a href="faq.html" title="FAQ">FAQ</a></li>
    3334                                </ul>
  • issm/trunk/doc/website/doc_html/installation.html

    r11 r378  
    2222                                        <li><a href="#Downloading the code" title="Downloading the code">Downloading the code</a></li>
    2323                                        <li><a href="#Configuration of your .bashrc" title="Configuration of your .bashrc">Configuration of your .bashrc</a></li>
    24                                         <li><a href="#Setting up the configuration file" title="Setting up the configuration file">Setting up the configuration file</a></li>
    25                                         <li><a href="#Packages installation" title="Packages installation">Packages installation</a></li>
     24                                        <li><a href="#External packages installation" title="External packages installation">External packages installation</a></li>
     25                                        <li><a href="#Development packages installation" title="Development packages installation">Development packages installation</a></li>
    2626                                        <li><a href="#ISSM compilation" title="ISSM compilation">ISSM compilation</a></li>
    2727                                </ul>
     
    3030
    3131                                <h1 id="Downloading the code">Downloading the code</h1>
    32                                 <p>To download ISSM, you can either use the link on the right panel or use <a href="http://www.nongnu.org/cvs/">CVS</a>.</p>
    33                                 <p>ISSM is actively managed using a code versioning  system called <a href="http://www.nongnu.org/cvs/">CVS</a>.
     32                                <p>To download ISSM, you can either use the link on the right panel or use <a href="http://subversion.tigris.org/">SVN</a>.</p>
     33                                <p>ISSM is actively managed using a code versioning  system called <a href="http://subversion.tigris.org/">SVN</a>.
    3434                                The code is stored in a repository, and can be remotely fetched, modified, updated, and uploaded.
    3535                                This allows for multiple users to develop the code in an organized way.
    36                                 In order to fetch a version of the code, users will need to install <a href="http://www.nongnu.org/cvs/">CVS</a> on their machine.</p>
    37                                 <p>Once <a href="http://www.nongnu.org/cvs/">CVS</a> has been installed, issue the following command:</p>
    38                                 <div class="fragment"> > cvs -d useraccount@wilkes.jpl.nasa.gov:/home/larour/Ice_Repository  co -r ice2 -P ice1</div>
    39                                 <p>This command will download the stable version of the code ISSM named ice2 from the repository on the wilkes machine,
    40                                 located in the /home/larour/Ice_Repository directory, onto the current local directory (replace useraccount by your user name on wilkes).
    41                                 Users are free to choose whichever location they want and to rename ice1.  Users should not forget the -P option.
    42                                 Failing to do so would allow <a href="http://www.nongnu.org/cvs/">CVS</a> to fetch empty directories.
    43                                 This would result in a code structure not intended by the developers.</p>
     36                                In order to fetch a version of the code, users will need to install <a href="http://subversion.tigris.org/">SVN</a> on their machine.</p>
     37                                <p>Once <a href="http://subversion.tigris.org/">SVN</a> has been installed, ISSM can be downloaded by the following command:</p>
     38                                <div class="fragment"> > svn checkout http://s383-rhat/issm/svn</div>
     39                                <p>This command will download the last version of the code ISSM from the repository, onto the current local directory.
     40                                Users are free to choose whichever location they want and to rename issm.</p>
    4441
    4542
     
    5148                                        source $ISSM_DIR/etc/environment.sh
    5249                                </div>
    53                                 <p>Where ISSMPATH is the path of ISSM main directory (ex: /home/user1/issm1).
     50                                <p>Where ISSMPATH is the path of ISSM main directory (ex: /home/user1/svn/issm/trunk).
    5451                                When this is done, type in the prompt:</p>
    5552                                <div class="fragment"> > bash</div>
    5653
    5754
    58                                 <h1 id="Setting up the configuration file">Setting up the configuration file</h1>
    59                                 <p>For the next step, go to etc:</p>
    60                                 <div class="fragment"> > cd $ISSM_DIR/etc</div>
    61                                 <p>This directory holds configuration files needed by various makefiles
    62                                 across the ICE code to compile "C" code.  For this code to compile correctly,
    63                                 ICE needs to know which type of OS the user is running, and pick up
    64                                 the correct configuration file. By default, ICE will look for the
    65                                 config.mk file in the MexConfig directory. If this file does not
    66                                 point to the correct OS dependent configuration file, the compilation
    67                                 will fail.</p>
    68                                 <p>Users should therefore identify their OS configuration file in the
    69                                 set of configuration files present in the MexConfig directory (
    70                                 ex: config_linux.mk for a 32 bits linux OS, config_linux64.mk
    71                                 for a 64 bits linux OS, etc ...) and rename this file to config.mk</p>
    72                                 <p>For example, on a linux 32 bits platform, in the MexConfig directory,
    73                                 find the linux 32 bits configuration file, and type:</p>
    74                                 <div class="fragment"> > cp ./config_linux32.mk ./config.mk</div>
    75                                 <p>Users familiar with symbolic linking can also try:</p>
    76                                 <div class="fragment"> > ln -s  ./config_linux32.mk ./config.mk</div>
    77                                 <p>The rest of the files in this directory are related to matlab compiler settings
    78                                 that have been tweaked for platform compatibility purposes. Users should not
    79                                 modify them, unless familiar with the 'mex' compiler.</p>
    80 
    81 
    82                                 <h1 id="Packages installation">Packages installation</h1>
     55                                <h1 id="External packages installation">External packages installation</h1>
    8356                                <p>For the next step, go to packages directory:</p>
    84                                 <div class="fragment"> > cd $ISSM_DIR/packages</div>
     57                                <div class="fragment"> > cd $ISSM_DIR/externalpackages</div>
    8558                                <p>several packages may be installed depending on what users want to do.
    86                                 At least the following two packages must be installed:</p>
     59                                At least the following for packages must be installed:</p>
    8760                                <ul>
     61                                        <li>mpich2</li>
     62                                        <li>petsc</li>
    8863                                        <li>metis</li>
    8964                                        <li>triangle</li>
     
    9873
    9974
     75                                <h1 id="Development packages installation">Development packages installation</h1>
     76                                <p>To generate the MakeFiles, one needs to install automake and autoconf that automatically generate
     77                                them. To do so, go to devpackages directory</p>
     78                                <div class="fragment"> > cd $ISSM_DIR/devpackages</div>
     79                                <p>and install these two packages by typing:</p>
     80                                <div class="fragment"> > make</div>
     81                                <p>To generate the MakeFiles needed to compile ISSM, go to ISSM's main directory and use the following commands:</p>
     82                                <div class="fragment"> > cd $ISSM_DIR <br>
     83                                        > ./reconfigure.sh <br>
     84                                        > ./configure.sh </div>
     85                                <p>One might need to modify the configure.sh file that holds all the options needed by automake and autoconf. These options
     86                                are only valid for JPL user's.</p>
     87
     88
    10089                                <h1 id="ISSM compilation">ISSM compilation</h1>
    10190                                <p>The final step consists in compiling all the modules of ISSM. Go to ISSM main directory and type:</p>
    10291                                <div class="fragment"> > cd $ISSM_DIR <br>
    103                                         >make -f MakefileIce
     92                                        > make
     93                                </div>
     94                                <p>Once the compilation has ended without error, the installation can be completed with:</p>
     95                                <div class="fragment"> > cd $ISSM_DIR <br>
     96                                        > make
    10497                                </div>
    10598                                <p>ISSM installation is done!</p>
    10699                        </div>
     100
    107101
    108102                        <div id="menu">
     
    115109                                        <li><a href="download.html" title="Download">Download</a></li>
    116110                                        <li><a href="installation.html" title="Installation">Installation</a></li>
    117                                         <li><a href="wiki.html" title="Developers Site">Developers Site</a></li>
     111                                        <li><a href="quickstart.html" title="Quick start">Quick start</a></li>
     112                                        <li><a href="http://s383-rhat/trac/issm/" title="Developers Site">Developers Site</a></li>
    118113                                        <li><a href="faq.html" title="FAQ">FAQ</a></li>
    119114                                </ul>
Note: See TracChangeset for help on using the changeset viewer.