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
Next revision Both sides next revision
development_version [2017/02/22 06:01]
Ed Bueler [Installing tools and libraries]
development_version [2020/02/14 00:04]
Ed Bueler
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>​
Line 9: Line 11:
 ===== 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 70: Line 72:
 </​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-docs.org/​sphinx/​manual/index.html|User'​s Manual]] to get the user-level view of PISM even if you think you know everything.
- +
-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.+
  
 +When working with the ''​dev''​ branch you should build documentation yourself; see [[http://​pism-docs.org/​sphinx/​installation/​documentation.html|the Installation Manual]] for instructions.
development_version.txt · Last modified: 2020/09/02 22:35 by Ed Bueler
© 2020 by PISM | webmaster