Python packages - qceff table pretty printer

[hkershaw-brown]

Description:

The qceff table has a lot of info, which is hard to read.
This python package provides display-qceff-table which pretty prints the qceff table for qceff.csv files.

It is in a python package so people can install with:
pip install -e DART/pytools/pyqceff

and use display-qceff-table without the full path.

Also allows packages to be put individually on pypi

There is also pyDART.txt which is list (one package in it currently) to install DART/pytools
pip install -r pyDART.txt

Example of pretty-print:

Usage:

(py-env) [hkershaw:pytools](python-packages) > display-qceff-table --help                                    
usage: display-qceff-table [-h] [--details [QTY]] csv_file

Display QCEFF table summary and details.

positional arguments:
  csv_file         Path to QCEFF table CSV file

options:
  -h, --help       show this help message and exit
  --details [QTY]  Print detailed information for all quantities, or for a specific quantity QTY

Fixes issue

No issue

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update

Documentation changes needed?

• My change requires a change to the documentation.
  • I have updated the documentation accordingly.

No docs, draft pull request to see what people think.

Tests

Please describe any tests you ran to verify your changes.
There is a test directory, but this test is only checking the QTYs are in the printed output.

cd DART/pytools
pytest

Checklist for merging

• Updated changelog entry
• Documentation updated
• Update conf.py

Checklist for release

• Merge into main
• Create release from the main branch with appropriate tag
• Delete feature-branch

Testing Datasets

• Dataset needed for testing available upon request
• Dataset download instructions included
• No dataset needed

[hkershaw-brown]

Note I am not sure on the gamma & beta closed vs open [ vs ( have to check the .f90 code. Currently printing [ for closed.

[hkershaw-brown]

python 3.8, could switch to 3.9+ but is python 3.8 still knocking about on some clusters.

[hkershaw-brown]

@hkershaw-brown chat to @mjs2369 about namespace package