neqsim-notebook-patterns

Jupyter Notebook Patterns for NeqSim

Standard patterns for creating Jupyter notebooks that use workspace NeqSim Java classes via devtools.

Devtools Setup Cell (Use in Every Task Notebook)

Task notebooks under task_solve/ MUST load NeqSim through devtools/neqsim_dev_setup.py. This puts workspace Java classes from target/classes on the JVM classpath, so new or modified Java classes are available without copying a packaged JAR into the neqsim Python package.

import os
import sys
from pathlib import Path


def find_neqsim_project_root():
    env_root = os.environ.get("NEQSIM_PROJECT_ROOT")
    candidates = []
    if env_root:
        candidates.append(Path(env_root).resolve())
    cwd = Path.cwd().resolve()
    candidates.extend([cwd] + list(cwd.parents))
    for candidate in candidates:
        if (candidate / "pom.xml").exists() and (candidate / "devtools" / "neqsim_dev_setup.py").exists():
            return candidate
    raise RuntimeError("Could not find NeqSim project root. Set NEQSIM_PROJECT_ROOT.")


PROJECT_ROOT = find_neqsim_project_root()
sys.path.insert(0, str(PROJECT_ROOT / "devtools"))

from neqsim_dev_setup import neqsim_init, neqsim_classes

ns = neqsim_init(project_root=PROJECT_ROOT, recompile=False, verbose=True)
ns = neqsim_classes(ns)
NEQSIM_MODE = "devtools"
print("NeqSim loaded via devtools workspace classes")

Class Import Cell

# Classes are already available on ns from neqsim_classes(ns):
SystemSrkEos = ns.SystemSrkEos
ProcessSystem = ns.ProcessSystem
Stream = ns.Stream
Separator = ns.Separator
Compressor = ns.Compressor
Cooler = ns.Cooler
Heater = ns.Heater
ThrottlingValve = ns.ThrottlingValve
Mixer = ns.Mixer
Splitter = ns.Splitter

Do not use from neqsim import jneqsim in task notebooks or runner workflows. That imports the installed Python package and can miss workspace Java changes. Only published Colab-style examples outside task_solve/ may use jneqsim as an external-user pattern.

Common Class Paths