History
=======

This package was developed internally at Equinor starting in 2017
based on several internal codes in Python and other
languages. Open sourced (LGPLv3) in 2019.

Release notes
=============

.. Release note sections:
   New features
   Improvements
   Bugfixes
   Deprecations
   Dependencies
   Miscellaneous

Detailed release history (with minor releases) at

  * https://github.com/equinor/pyscal/releases

v0.8.x
------
**New features**
  - New saturation endpoint for gas condensate modelling ``sgro``, and
    reintroduced ``kromax`` endpoint when ``sgro > 0``.
  - sgrw can be used as an alias for sorw, relevant for gas-water problems
    with condensate.
  - Pyscal is now type hinted.

**Changes**
  - The internal dataframes now have their column names upper cased. This
    is not part of the public API.
  - Deprecated API for monotonicity specification has been removed
  - Deprecated interpolation code has been removed.
  - Individual interpolation parameters pr SATNUM can no longer be given to
    the command line tool.

**Fixes**
  - Pyscallists had some initialization bugs that are now fixed for API users.
  - Avoid bug when initializing from tabulated values with linear curves.

v0.7.x
------
**New features**
  - Monotonocity is always enforced (in the last digit) in relative
    permeability data, unless fast mode is activated.
  - ``swl`` can be initialized from height-above-free-water-level, if simple J
    parameters are included in input table.
  - ``swcr`` can be initialized relative to ``swl``, by using the ``swcr_add``
    parameter in the input table.
  - PyscalFactory can create objects with fast mode enabled.

**Deprecations**
  - Dropped Python2 support.
  - SATNUM specific interpolation parameters are deprecated in the command line
    client.

v0.6.0
------
**Changes**
  - In previous versions, the oil relperm curve in WaterOil started with
    ``kro(swcr) = kroend``. Now it starts with ``kro(swl) = kroend``. Thus,
    if ``swcr > swl``, your oil relperm will change when moving to Pyscal 0.6.x.
  - In previous versions, the oil relperm curve in GasOil started with
    ``kro(sgcr) = kroend``. Now it starts with ``kro(0) = kroend``. Thus,
    if ``sgcr > 0`` (more common than ``swcr > swl``), your oil relperm will
    change when moving to Pyscal 0.6.x. The oil relative permeability will
    in general be lowered through this change, and the change can be
    significant for large ``sgcr``.
**Deprecations**
  - kromax is no longer in use by pyscal. The oil relperm curve is anchored
    at kroend (and krowend and krogend are renamed to kroend accordingly, as
    they cannot be different any longer)
**New features**
  - Support for GasWater.

v0.5.0
------
**New features**
  - Adds saturation points between sorw and 1 in WaterOil saturation tables.

v0.4.0
------

**New features**
  - Added command line tool

v0.3.0
------

**Improvements**
  - Rewritten interpolation code

v0.2.0
------
**New features**
  - Includes PyscalFactory for creating objects.

v0.1.0
------

**Miscellaneous**
  - first open source version