v3.15.0

Author: EvenSol

conda/meta.yaml

@@ -1,5 +1,5 @@
 {% set name = "neqsim" %}
-{% set version = "3.14.0" %}
+{% set version = "3.15.0" %}
 
 package:
   name: {{ name|lower }}

docs/release-notes/v3.15.0.md

@@ -0,0 +1,43 @@
+# NeqSim Python 3.15.0
+
+NeqSim Python is the Python interface to the NeqSim engine for thermodynamic calculations, physical properties, process simulation, and PVT analysis from Python and Jupyter notebooks.
+
+## Highlights
+
+- Aligns Python package metadata and the conda recipe with version 3.15.0.
+- Improves editor code completion by shipping typing stubs for `jneqsim` through the `neqsim` package export.
+- Ensures `jneqsim` and `jpype` stub packages are included in built source distributions.
+
+## Install
+
+Use pip when you already have Java installed:
+
+```bash
+pip install --upgrade neqsim==3.15.0
+```
+
+Use conda when you want OpenJDK installed with the package:
+
+```bash
+conda install -c conda-forge neqsim=3.15.0
+```
+
+Requirements:
+
+- Python 3.9 or newer.
+- Java 11 or newer for pip installs.
+- Conda installs include OpenJDK through conda-forge.
+
+Verify the installed package version without starting the JVM:
+
+```bash
+python -c "from importlib.metadata import version; print(version('neqsim'))"
+```
+
+## Useful Links
+
+- Full changelog: https://github.com/equinor/neqsim-python/compare/v3.14.0...v3.15.0
+- Documentation: https://equinor.github.io/neqsimhome/
+- Python examples: https://github.com/equinor/neqsim-python/tree/master/examples
+- Java engine: https://github.com/equinor/neqsim
+- Discussions: https://github.com/equinor/neqsim/discussions

environment.yml

@@ -19,4 +19,4 @@ dependencies:
   # Install neqsim from PyPI until conda-forge package is available
   - pip
   - pip:
-    - neqsim==3.14.0
+    - neqsim==3.15.0

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "neqsim"
-version = "3.14.0"
+version = "3.15.0"
 description = "NeqSim is a tool for thermodynamic and process calculations"
 authors = [{ name = "Even Solbraa", email = "esolbraa@gmail.com" }]
 requires-python = ">=3.9,<4"
@@ -50,6 +50,9 @@ namespace = true
 # Include the stub package in distributions using glob patterns
 source-include = [
     "src/jneqsim-stubs/**",
+    "src/jpype-stubs/**",
+    "src/neqsim/**/*.pyi",
+    "src/neqsim/py.typed",
 ]
 
 [build-system]

src/jneqsim-stubs/jneqsim/__init__.pyi

@@ -0,0 +1,43 @@
+
+import sys
+if sys.version_info >= (3, 8):
+    from typing import Protocol
+else:
+    from typing_extensions import Protocol
+
+import jneqsim.api
+import jneqsim.blackoil
+import jneqsim.chemicalreactions
+import jneqsim.datapresentation
+import jneqsim.fluidmechanics
+import jneqsim.integration
+import jneqsim.mathlib
+import jneqsim.physicalproperties
+import jneqsim.process
+import jneqsim.pvtsimulation
+import jneqsim.standards
+import jneqsim.statistics
+import jneqsim.thermo
+import jneqsim.thermodynamicoperations
+import jneqsim.util
+import typing
+
+
+class __module_protocol__(Protocol):
+    # A module protocol which reflects the result of ``jp.JPackage("neqsim")``.
+
+    api: jneqsim.api.__module_protocol__
+    blackoil: jneqsim.blackoil.__module_protocol__
+    chemicalreactions: jneqsim.chemicalreactions.__module_protocol__
+    datapresentation: jneqsim.datapresentation.__module_protocol__
+    fluidmechanics: jneqsim.fluidmechanics.__module_protocol__
+    integration: jneqsim.integration.__module_protocol__
+    mathlib: jneqsim.mathlib.__module_protocol__
+    physicalproperties: jneqsim.physicalproperties.__module_protocol__
+    process: jneqsim.process.__module_protocol__
+    pvtsimulation: jneqsim.pvtsimulation.__module_protocol__
+    standards: jneqsim.standards.__module_protocol__
+    statistics: jneqsim.statistics.__module_protocol__
+    thermo: jneqsim.thermo.__module_protocol__
+    thermodynamicoperations: jneqsim.thermodynamicoperations.__module_protocol__
+    util: jneqsim.util.__module_protocol__

src/jneqsim-stubs/jneqsim/api/__init__.pyi

@@ -0,0 +1,15 @@
+
+import sys
+if sys.version_info >= (3, 8):
+    from typing import Protocol
+else:
+    from typing_extensions import Protocol
+
+import jneqsim.api.ioc
+import typing
+
+
+class __module_protocol__(Protocol):
+    # A module protocol which reflects the result of ``jp.JPackage("jneqsim.api")``.
+
+    ioc: jneqsim.api.ioc.__module_protocol__

src/jneqsim-stubs/jneqsim/api/ioc/__init__.pyi

@@ -0,0 +1,25 @@
+
+import sys
+if sys.version_info >= (3, 8):
+    from typing import Protocol
+else:
+    from typing_extensions import Protocol
+
+import java.lang
+import jpype
+import typing
+
+
+
+class CalculationResult:
+    fluidProperties: typing.MutableSequence[typing.MutableSequence[float]] = ...
+    calculationError: typing.MutableSequence[java.lang.String] = ...
+    def __init__(self, doubleArray: typing.Union[typing.List[typing.MutableSequence[float]], jpype.JArray], stringArray: typing.Union[typing.List[java.lang.String], jpype.JArray]): ...
+    def equals(self, object: typing.Any) -> bool: ...
+    def hashCode(self) -> int: ...
+
+
+class __module_protocol__(Protocol):
+    # A module protocol which reflects the result of ``jp.JPackage("jneqsim.api.ioc")``.
+
+    CalculationResult: typing.Type[CalculationResult]

src/jneqsim-stubs/jneqsim/blackoil/__init__.pyi

@@ -0,0 +1,113 @@
+
+import sys
+if sys.version_info >= (3, 8):
+    from typing import Protocol
+else:
+    from typing_extensions import Protocol
+
+import java.util
+import jpype
+import jneqsim.blackoil.io
+import jneqsim.thermo.system
+import typing
+
+
+
+class BlackOilConverter:
+    def __init__(self): ...
+    @staticmethod
+    def convert(systemInterface: jneqsim.thermo.system.SystemInterface, double: float, doubleArray: typing.Union[typing.List[float], jpype.JArray], double3: float, double4: float) -> 'BlackOilConverter.Result': ...
+    class Result:
+        pvt: 'BlackOilPVTTable' = ...
+        blackOilSystem: 'SystemBlackOil' = ...
+        rho_o_sc: float = ...
+        rho_g_sc: float = ...
+        rho_w_sc: float = ...
+        bubblePoint: float = ...
+        def __init__(self): ...
+
+class BlackOilFlash:
+    def __init__(self, blackOilPVTTable: 'BlackOilPVTTable', double: float, double2: float, double3: float): ...
+    def flash(self, double: float, double2: float, double3: float, double4: float, double5: float) -> 'BlackOilFlashResult': ...
+
+class BlackOilFlashResult:
+    O_std: float = ...
+    Gf_std: float = ...
+    W_std: float = ...
+    V_o: float = ...
+    V_g: float = ...
+    V_w: float = ...
+    rho_o: float = ...
+    rho_g: float = ...
+    rho_w: float = ...
+    mu_o: float = ...
+    mu_g: float = ...
+    mu_w: float = ...
+    Rs: float = ...
+    Rv: float = ...
+    Bo: float = ...
+    Bg: float = ...
+    Bw: float = ...
+    def __init__(self): ...
+
+class BlackOilPVTTable:
+    def __init__(self, list: java.util.List['BlackOilPVTTable.Record'], double: float): ...
+    def Bg(self, double: float) -> float: ...
+    def Bo(self, double: float) -> float: ...
+    def Bw(self, double: float) -> float: ...
+    def Rs(self, double: float) -> float: ...
+    def RsEffective(self, double: float) -> float: ...
+    def Rv(self, double: float) -> float: ...
+    def getBubblePointP(self) -> float: ...
+    def mu_g(self, double: float) -> float: ...
+    def mu_o(self, double: float) -> float: ...
+    def mu_w(self, double: float) -> float: ...
+    class Record:
+        p: float = ...
+        Rs: float = ...
+        Bo: float = ...
+        mu_o: float = ...
+        Bg: float = ...
+        mu_g: float = ...
+        Rv: float = ...
+        Bw: float = ...
+        mu_w: float = ...
+        def __init__(self, double: float, double2: float, double3: float, double4: float, double5: float, double6: float, double7: float, double8: float, double9: float): ...
+
+class SystemBlackOil:
+    def __init__(self, blackOilPVTTable: BlackOilPVTTable, double: float, double2: float, double3: float): ...
+    def copyShallow(self) -> 'SystemBlackOil': ...
+    def flash(self) -> BlackOilFlashResult: ...
+    def getBg(self) -> float: ...
+    def getBo(self) -> float: ...
+    def getBw(self) -> float: ...
+    def getGasDensity(self) -> float: ...
+    def getGasReservoirVolume(self) -> float: ...
+    def getGasStdTotal(self) -> float: ...
+    def getGasViscosity(self) -> float: ...
+    def getOilDensity(self) -> float: ...
+    def getOilReservoirVolume(self) -> float: ...
+    def getOilStdTotal(self) -> float: ...
+    def getOilViscosity(self) -> float: ...
+    def getPressure(self) -> float: ...
+    def getRs(self) -> float: ...
+    def getRv(self) -> float: ...
+    def getTemperature(self) -> float: ...
+    def getWaterDensity(self) -> float: ...
+    def getWaterReservoirVolume(self) -> float: ...
+    def getWaterStd(self) -> float: ...
+    def getWaterViscosity(self) -> float: ...
+    def setPressure(self, double: float) -> None: ...
+    def setStdTotals(self, double: float, double2: float, double3: float) -> None: ...
+    def setTemperature(self, double: float) -> None: ...
+
+
+class __module_protocol__(Protocol):
+    # A module protocol which reflects the result of ``jp.JPackage("jneqsim.blackoil")``.
+
+    BlackOilConverter: typing.Type[BlackOilConverter]
+    BlackOilFlash: typing.Type[BlackOilFlash]
+    BlackOilFlashResult: typing.Type[BlackOilFlashResult]
+    BlackOilPVTTable: typing.Type[BlackOilPVTTable]
+    SystemBlackOil: typing.Type[SystemBlackOil]
+    io: jneqsim.blackoil.io.__module_protocol__