Developer Guide

This PFLOTRAN Developer Guide better ensures PFLOTRAN quality, integrity, robustness and longevity (for the PFLOTRAN community) by training code developers, who will be making modifications to documentation, source code or tests, regarding effective software development practices. A key requirement for receiving permission to contribute to the online PFLOTRAN Bitbucket repository (aka push privileges) is to review this document and discuss the guidelines with a Senior PFLOTRAN Developer. Developers receive additional training through the review and approval process that is required to merge new features to the repository.

• Glossary
• Development Methodology
• Development Life Cycle
  • Linkage to Quality Assurance and Configuration Management
  • Retirement
• Configuration Management Plan
  • Organizational Roles and Responsibilities
  • Configurable Items
  • Approach to Storing PFLOTRAN Configurable Items
  • Approach to Git Version Control
  • Configuration Management FAQ
• Software Productivity and Sustainability Plan - Required by DOE Office of Science
  • Overall Software Development Process
  • Tools and Processes
  • Training
  • Improvement Strategies
• Review and Approval
  • Review and Approval for Software Releases
• Maintenance, Problem Reporting and Corrective Action

Standards:

• Contributing to the PFLOTRAN Project
• PFLOTRAN Fortran Formatting Protocol
  • Guidelines
  • Filename and Module/Class Naming Convention
  • Example Fortran Source Code

QA Test Suite

• Pc-Saturation & Relative Permeability Functions
  • How To Test Characteristic Curves
  • Testing Results For Pc-Saturation Functions
  • Testing Results For Relative Permeability Functions

FAQ

• How do I get help?
• How can I contribute to or update the online documentation?
  • Fork Option (Beginner)
  • Branch Option (Advanced)
  • Common Bitbucket and Git Questions
• How do I resolve installation issues?
  • No such file /conf/variables
  • PFLOTRAN doesn’t compile when I type make pflotran.
• How do I make any sense of the screen output, in particular Newton iteration convergence?
  • Standard Flow
  • GENERAL mode compiled with debug_gen=2
• How do I create datasets and are there examples?
  • Permeability and/or Porosity
  • Material IDs
  • Regions
  • Other Cell-Indexed Datasets
  • Gridded Datasets
  • ASCII Datasets
• Why does PFLOTRAN crash when printing provenance information to HDF5 formatted output?
• Does PFLOTRAN run on a machine with GPUs?
• What is the difference between MAPPED, GLOBAL, CELL_INDEXED, GRIDDED and ASCII datasets?
• How can I troubleshoot multi-phase flow problems in GENERAL mode?