pyscal.pyscalcli

Command line tool for pyscal

pyscal.pyscalcli.get_parser()[source]

Construct the argparse parser for the command line script.

Return type:

ArgumentParser

Returns:

argparse.Parser

pyscal.pyscalcli.main()[source]

Endpoint for pyscals command line utility.

Translates from argparse API to Pyscal’s Python API

Return type:

None

pyscal.pyscalcli.pyscal_main(parametertable, verbose=False, debug=False, output='relperm.inc', delta_s=None, int_param_wo=None, int_param_go=None, sheet_name=None, slgof=False, family2=False, plot=False, plot_pc=False, plot_semilog=False, plot_outdir='./')[source]

A “main()” method not relying on argparse. This can be used for testing, and also by an ERT forward model, e.g. in semeio (github.com/equinor/semeio)

Parameters:

  • parametertable (str) – Filename (CSV or XLSX) to load

  • verbose (bool) – verbose or not

  • debug (bool) – debug mode or not

  • output (str) – Output filename

  • delta_s (Optional[float]) – Saturation step-length

  • int_param_wo (Optional[float]) – Interpolation parameter for wateroil

  • int_param_go (Optional[float]) – Interpolation parameter for gasoil

  • sheet_name (Optional[str]) – Which sheet in XLSX file

  • slgof (bool) – Use SLGOF

  • family2 (bool) – Dump family 2 keywords

  • plot (bool) – Plot relative permeability figures and save

  • plot_pc (bool) – Plot capillary pressure curves in addition to relperm curves

  • plot_semilog (bool) – Plot relative permeability figures with log y-axis

Return type:

None