jNeqSim

Python interface for the NeqSim java package, with stubs. Java interface is created with jpype, and stubs are generated with stubgenj

PYPI

https://pypi.org/project/jneqsim/

[!NOTE] JNeqSim mirrors NeqSims versions

Demo

Example

from jneqsim import neqsim


def pressurize_gas():
    inlet_fluid = neqsim.thermo.system.SystemSrkEos()
    neqsim.thermo.system.SystemSrkEos()
    thermo_ops = neqsim.thermodynamicOperations.ThermodynamicOperations(inlet_fluid)
    inlet_fluid.addComponent("methane", 100.0)

    inlet_fluid.setTemperature(10, "C")
    inlet_fluid.setPressure(20, "bara")
    inlet_fluid.setMultiPhaseCheck(True)
    inlet_fluid.setSolidPhaseCheck("methane")

    thermo_ops.TPflash()
    thermo_ops.bubblePointTemperatureFlash()

    inlet_fluid.initProperties()
    enthalpy = inlet_fluid.getEnthalpy()

    inlet_fluid.setPressure(1.0, "bara")
    thermo_ops.PHflash(enthalpy)

Dependencies

jpype

Version Management

jneqsim uses a controlled release process to ensure compatibility:

Pinned Versions: Each jneqsim release is pinned to a specific, tested NeqSim JAR version
Automated Updates: The nightly CI workflow automatically checks for new NeqSim releases and publishes updated jneqsim packages when available
No Auto-Updates: Applications using jneqsim will not automatically download newer NeqSim versions - they use the tested version that comes with their installed jneqsim package
Cache Management: Downloaded JARs are cached locally in ~/.jneqsim/cache for faster subsequent usage

Development

Running Tests

The project uses pytest with custom markers to categorize tests. Test dependencies are already included in the development dependencies.

# Install development dependencies (includes pytest and pytest-mock)
poetry install

# Run unit tests (fast, excludes tests marked as slow)
pytest -v -m "not slow" tests/

# Run all tests (may download JARs for integration tests)
pytest -v tests/

# Run with coverage (requires pytest-cov)
poetry add --group dev pytest-cov
poetry run pytest --cov=jneqsim --cov-report=html tests/

Test markers:

slow: Tests that may download files or take longer to run
integration: Integration tests that require external dependencies
unit: Fast unit tests (default)

:+1: Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Release files for jneqsim 3.20.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jneqsim 3.20.0
File	Size	Uploaded
jneqsim-3.20.0.tar.gz	3.0 MB	Sep 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for jneqsim 3.20.0
File	Interpreter	ABI	Platform	Reset
jneqsim-3.20.0-py3-none-any.whl 973.5 kB Sep 9, 2026	Python 3	none	any	Details

Total release size: 3.9 MB

Release files / jneqsim-3.20.0.tar.gz

Download URL	jneqsim-3.20.0.tar.gz
Size	3.0 MB
Tags	Source
SHA-256 checksum How to use checksums	`23959120d1434a24c37d2d9ecde6b89db390735bbd6f19017c4aa6fce1818160`
BLAKE2b-256 checksum How to use checksums	`d48ede9028af8a03f90198dea27750e287dfad4f377a3cd2929b8737a0efa17a`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / jneqsim-3.20.0-py3-none-any.whl

Download URL	jneqsim-3.20.0-py3-none-any.whl
Size	973.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`644e212d4b7213486594be43b8f83794a3bdf821b0b7610c207bbf7580ab6dc2`
BLAKE2b-256 checksum How to use checksums	`497bf055c0937f8ddbc9833b45b47c2c218785ed09ec2410941982aa49d79577`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`