Installing PLUME

PLUME: Plasma in a Linear Uniform Magnetized Environment

These are the install instructions for the PLUME code: the Plasma in a Linear Uniform Magnetized Environment.

Authors

Kristopher Klein (kgklein@arizona.edu) Gregory Howes (gregory-howes@uiowa.edu)

CONTENTS

  1. Requirements and Dependencies
  2. Getting the PLUME Code
  3. Installing the PLUME Code
  4. Execution of Test Runs

REQUIREMENTS AND DEPENDENCIES

PLUME has the following requirements:

  • A UNIX, Linux, or macOS operating system with a working shell.
  • GNU make.
  • Fortran 90 compiler (e.g., gfortran) - we recommend using the latest version of the compiler to avoid any surprises in the evaluation.

GETTING THE PLUME CODE

We recommend pulling the latest version of PLUME from GitHub. For this, go to the directory where you want to install PLUME and execute the following command:

git clone https://github.com/kgklein/PLUME.git

Alternatively, you can also go to the website https://https://github.com/kgklein/PLUME

directly and download the source code from there. The advantage of using the git command is that you can now contribute to the development of the PLUME code. If you make any changes to the code, GitHub will run automatic tests (via workflows) to ensure that the changes do not break the code.

INSTALLING THE PLUME CODE

There are no additional dependencies for compiling the code, so running

make

should be sufficent if using gfortran. If using another FORTRAN90 compiler, simply add that compiler to the Makefile and compile.

Running

make tidyup

will move the extraneous .o and .mod files to the include directory.

If you need a clean compilations, run

make clean

This will remove all of the files from the include directory as well as the compiled executable, enabling a clean recompilation if necessary.

EXECUTION OF TEST RUNS

PLUME comes with a selection of test runs that cycle through various test problems. To execute a small set of tests, navigate to inputs/example/ and execute the following shell script:

./run_example.sh

This script will run a simple parallel wavevector scan after identifying four modes at MHD length scales.

More example cases will be added.

Building the documentation

PLUME uses Ford to build its documentation. The documentation is automatically built and deployed to github.io by the doc workflow. To build the documentation locally, follow the Build documentation step in the workflow, summarized here: 1. Install ford by e.g. pip install ford. See Ford documentation for details 2. Create a docs directory by mkdir docs 3. Add a line title: Readme to the top of README.md and copy it to docs/index.md 4. Add a line title: Install to the top of INSTALL.md and copy it to docs/INSTALL.md 5. Run ford ford_project.md 6. Open docs/index.html in a browser to view the documentation

Adding static pages to documentation

The README.md and INSTALL.md files are added to the Ford documentation as static pages. You can add more static pages to the documentation by 1. Add the content in a markdown file to the repository. 2. Add a title: line to the beginning of the file and copy it to docs/ in the doc workflow. See steps 3-4 in the previous section, or the Build documentation step in the workflow. 3. Add the name of the markdown file as a new line under ordered_subpage in ford_project.md