gkvfig 0.1.1

A Python package for generating PDF of GKV standard ASCII output

gkvfig - Generating PDF of GKV standard output

---

gkvfig is a Python package that generates a summary figure PDF of GKV standard ASCII output. (Previous fig_stdout tool using shell/awk/gnuplot/latex is converted to Python.)

Installation

To install from PyPI:

pip install gkvfig

Or install the latest development version from GitHub:

pip install git+https://github.com/GKV-developers/gkvfig.git

Usage

(i) Basic usage: As a command line tool

python -m gkvfig -d DIR

The argument DIR is the path of GKV output directory. The namelist file DIR/gkvp.namelist.001, log file DIR/log/gkvp.000000.0.log.001, and hst directory DIR/hst/ should exist. You get a summary PDF file CWD/figpdf_yyyymmdd_hhmmss/fig_stdout.pdf.

(ii) As a Python function

from gkvfig import gkvfig

gkvfig(gkv_stdout_dir="YOUR GKV OUTPUT DIR")

You get a summary PDF file CWD/figpdf_yyyymmdd_hhmmss/fig_stdout.pdf, always in the current working directory CWD.

Dependencies

gkvfig requires the following Python packages:

• numpy, matplotlib, pandas, reportlab, pypdf

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Developed by Shinya Maeyama ([e-mail])