PumpKin

Last updated: 8-Sep-2016

A tool to find principal pathways in plasma chemical models

How to Use

System Requirements

PumpKin is written in the C++ programming language. It has been tested on Mac OS X, Linux OS and Microsoft Windows. A C++ compiler is required. We have tested PumpKin with the following compilers: GCC and LLVM. We recommend Windows users to use Cygwin, which implements a GNU toolchain in the Windows architecture. In general here are the general requirements:

     • To build PumpKin, the GNU version of make (GNUmake) must be installed. The PumpKin makefile requires GNU make version 3.77 or later. GNU software can be downloaded from many places, including http://www.gnu.org/software/make/

    • A C++ compiler is required. PumpKin makes heavy use of the ISO/IEC 14882 C++ Standard. Some compilers are not fully compliant with this specification, although most are. PumpKin has been compiled and tested with. 

            • LLVM 3.2 or higher 

            • GNU g++ 3.32 or higher

    • GLPK (GNU linear programming kit) must be installed. This allows PumpKin to solve large-scale linear programming (LP) problems. GLPK can be downloaded from www.gnu.org/software/glpk/ or using tools like MacPorts (www.macports.org) or Fink (www.finkproject.org) for Mac OS X and package management systems for GNU/Linux distributions. The windows user can get installation instructions at (http://winglpk.sourceforge.net).

    • We have tested PumpKin with GLPK version higher than 4.32. 

The recommended system requirements depend on the choice of the input parameters and the problem size. As a reference, in a MacBook Pro 15-inch (Mid 2010) with a CPU Intel Core i5 at 2.4 GHz, 4 GB (1067 MHz DDR3) of RAM memory and the operating system Mac OS X 10.9, PumpKin runs the examples in about 30 seconds. When the input files are large, PumpKin will require more time to load them into the computer memory. 

Installation

The PumpKin package is distributed in the form of a packed archive (a tarball). It is one file named pumpkin-X.Y.tar.gz, where X is the major version number and Y is the minor version number; for example, the archive name might be pumpkin-1.1.tar.gz. In order to install the distribution you should:

     1. Copy the pumpkin distribution file to a working directory. Unpack the distribution file with the following command

                         $ tar -xzf pumpkin-X.Y.tar.gz

     2. After unpacking and unarchiving the PumpKin distribution you can compile (build) the package. For this, normally, you should just type

                         $ cd pumpkin-X.Y/src

                         $ make

     Advanced users may want to modify the Makefile to change compiler or the location of GLPK.

     3. The user can run PumpKin by typing the following command

                         $ ./pumpkin [input folder]

     where [input folder] is the location of the input folder. If the user doesn’t specify the location of input folder, PumpKin by default will look it in the current folder, i.e. pumpkin-X.Y/src/Input.

For more detailed information about installation and usage we refer our users to read PumpKin user manual.

Copyright © 2013-2017 Aram H. Markosyan. All rights reserved.