Documentation for PISM, the Parallel Ice Sheet Model

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
development_version [2017/02/22 06:01]
Ed Bueler [Installing tools and libraries]
development_version [2020/09/02 22:35] (current)
Ed Bueler point to dev version of manual
Line 1: Line 1:
 ===== Getting the dev source code ===== ===== Getting the dev source code =====
  
-The PISM source code is hosted at [[http://​github.com/​pism/​pism|github.com/​pism/​pism]]. ​ The default branch is set to the current stable version of PISM.  To get the ''​dev''​ branch you can either clone the repository and then checkout the ''​dev''​ branch, or you can ask for the ''​dev''​ branch from the start:+The PISM source code is hosted at [[http://​github.com/​pism/​pism|github.com/​pism/​pism]]. ​ The default branch is ''​master'',​ which is the current stable version of PISM. 
 + 
 +To get the ''​dev''​ branch you can either clone the repository and then checkout the ''​dev''​ branch, or you can ask for the ''​dev''​ branch from the start:
  
 <​code>​ <​code>​
 git clone -b dev git://​github.com/​pism/​pism.git pism-dev git clone -b dev git://​github.com/​pism/​pism.git pism-dev
 </​code>​ </​code>​
 +
 +===== The dev manual ======
 +
 +See [[http://​pism.github.io/​pism/​]],​ which follows the ''​dev''​ branch. ​ Meanwhile the [[https://​pism-docs.org/​wiki/​doku.php?​id=overview|main documentation page]] corresponds to the most recent release.
  
 ===== Installing tools and libraries ===== ===== Installing tools and libraries =====
  
-See the {{:​installation.pdf|Installation Manual}} for the list of tools and libraries necessary to build PISM.+See the [[http://​pism-docs.org/​sphinx/​installation/index.html|Installation Manual]] for the list of tools and libraries necessary to build PISM.
  
 For the development version you need a recent version of [[http://​www.mcs.anl.gov/​petsc/​download/​index.html|PETSc]]. ​ Configuring and building PETSc might be as simple as<​code>​ For the development version you need a recent version of [[http://​www.mcs.anl.gov/​petsc/​download/​index.html|PETSc]]. ​ Configuring and building PETSc might be as simple as<​code>​
Line 54: Line 60:
   * use a RSS feed provided by GitHub: [[https://​github.com/​pism/​pism/​commits/​dev.atom]]   * use a RSS feed provided by GitHub: [[https://​github.com/​pism/​pism/​commits/​dev.atom]]
  
-Here are the latest five commits (obtained using the RSS feed link above):+Here are the latest five commits (from the RSS feed link above):
  
 {{rss>​https://​github.com/​pism/​pism/​commits/​dev.atom 5 author date 1h }} {{rss>​https://​github.com/​pism/​pism/​commits/​dev.atom 5 author date 1h }}
Line 70: Line 76:
 </​code> ​ </​code> ​
  
-See the {{manual.pdf|User'​s Manual}} to get the user-level view of PISM even if you think you know everything. +See the [[http://​pism.github.io/​pism/​|User'​s Manual ​(dev)]] ​to get the user-level view of PISM even if you think you know everything. ​ See also the [[http://pism.github.io/pism/installation/index.html|Installation Manual (dev)]] for instructions on how build the documentation ​yourself.
- +
-When working with the ''​dev''​ branch you should build documentation yourself by getting doxygen and LaTeX---if you don't have them installed already--and then making the appropriate target: +
- +
-<​code>​ +
-cd 'your build directory'​ +
-make manual ​             # builds manual.pdf +
-make installation ​       # builds installation.pdf +
-make forcing ​            # builds forcing.pdf +
-make browser ​            # doxygen docs; view doc/browser/html/​index.html ​when built +
-</​code>​  +
- +
-There is additional documentation for the new PISM Python bindings and inversion tools. ​ See the PDF Installation Manual (installation.pdf;​ built by ''​ make installation''​) for how to build the documentation ​for the Python bindings and inversion tools. ​ You will need Sphinx to build these docs. +
development_version.1487743282.txt.gz · Last modified: 2017/02/22 06:01 by Ed Bueler
© 2020 by PISM | webmaster