man Namespace Reference

Man page info. More...

Functions
void	print_manual (bool details=true)
	Prints 'man page' style info.

Variables
const std::string	name
const std::string	author
const std::string	synopsis
const std::string	description
const std::vector< std::pair< std::string, std::string > >	options

Detailed Description

Man page info.

Function Documentation

print_manual()

void man::print_manual

(

bool

details = true

)

Prints 'man page' style info.

Variable Documentation

name

const std::string man::name

Initial value:

{
  "ampsci: "
  "Atomic Many-body Perturbation theory in the Screened Coulomb Interaction."}

author

const std::string man::author

Initial value:

{"Benjamin M. Roberts (https://broberts.io/), "
                         "University of Queensland, Australia."}

synopsis

const std::string man::synopsis

Initial value:

{
  "ampsci [InputFile]                | Run with input file\n"
  "ampsci [Atom] <Core> <Valence>    | Basic Hartree-Fock run\n"
  "ampsci -s [InputString]           | Run with input string\n"
  "ampsci -i <InputBlock>            | Query input options\n"
  "ampsci -m <Module>                | Query module options\n"
  "ampsci -o <Operator>              | Query operator options\n"
  "ampsci -p <Atom> <Isotope>        | Periodic table, isotope info\n"
  "ampsci -c <value> <unit>          | Unit conversions\n"
  "ampsci -z [Basis] <core> <kmax>   | Check memory requirements\n"
  "ampsci -v                         | Ampsci version information\n"
  "ampsci -h                         | Detailed help information\n"}

description

const std::string man::description

Initial value:

{
  "ampsci is a C++ program for high-precision atomic structure calculations "
  "of single-valence systems.\n"
  "Full documentation (including of the physics methods) can be found "
  "online: https://ampsci.dev/"}