This section describe the platforms supported by PETGEM and the requirements to install it.


PETGEM is known to run on various flavors of Linux clusters.


Requirements packages for using PETGEM:

On Linux, consult the package manager of your preference. PETGEM can be used without any installation by running the kernel from the top-level directory of the distribution.

Install PETGEM

Please, look at and follow the instructions therein.

There are 3 ways to install PETGEM:

  • In-place use:

    $ python3 build_ext --inplace
  • For installation (system-wide):

    $ python3 build


    $ python3 install

    This option may require root privileges.

  • Local installation:

    $ python3 install --root=<install_prefix>

    This option requires write privileges to --root=<install_prefix>. Finally, the command to clean a PETGEM installation is:

    $ python3 clean

Install documentation

PETGEM is documented using Sphinx and LaTeX. The documentation source are in the doc directory.

The following steps summarize how to generate PETGEM documentation.

  1. Install Sphinx and LaTeX.
  2. If is necessary, edit the rst files in doc/ directory using your favorite text editor. Nothing fancy is needed since ReST format is really simple.
  3. (Re) generate the PETGEM documentation as follows:
  • By using script:

    $ python3 output_format

    since PETGEM actually support html and pdf formats, valid options for output_format = [pdfdocs, htmldocs].

  • By using Sphinx commands directly:

    $ cd doc
    $ make output_format

    where output_format = [html, latexpdf].