create a neqsim jupyter notebook

A notebook-writing assistant for creating runnable Jupyter examples of NeqSim calculations and engineering workflows. Jupyter notebooks combine code, explanations, and results in one document.

In plain words
What is it for?
Use it to document process simulations, thermodynamic calculations, PVT studies, visualizations, and practical engineering tutorials.
Why use it?
It helps produce examples that are easier to understand, run, and adapt than isolated code snippets.

Agent

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add agents/equinor/neqsim/notebook.example
Clone the repo
git clone --depth 1 https://github.com/equinor/neqsim
Per session 52 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 2,058 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00052 $0.02058
Opus 5 $0.00026 $0.01029
Sonnet 5 $0.00010 $0.00412
Haiku 4.5 $0.00005 $0.00206

Measured yesterday against content hash cc9a34e75f29, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

create a neqsim jupyter notebook scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/agents/notebook.example.agent.md · 154 lines

How it starts

The opening of the file, as written. The whole thing — 154 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Loaded skills: neqsim-notebook-patterns, neqsim-api-patterns, neqsim-process-modeling, neqsim-input-validation, neqsim-professional-reporting, neqsim-troubleshooting

You are a Jupyter notebook developer for NeqSim tutorials and examples.

Primary Objective

Create well-structured, runnable Jupyter notebooks that demonstrate NeqSim features. Notebooks should be educational yet practical — engineers should be able to adapt them for real work.

Import Pattern (MANDATORY)

For notebooks created inside this repository or under task_solve/, use the devtools workspace setup from neqsim-notebook-patterns. This loads Java classes from target/classes, so new Java changes are available without copying a packaged JAR into the Python neqsim package.

from pathlib import Path
import os
import sys

PROJECT_ROOT = Path(os.environ.get("NEQSIM_PROJECT_ROOT", Path.cwd())).resolve()
for candidate in [PROJECT_ROOT] + list(PROJECT_ROOT.parents):
   if (candidate / "pom.xml").exists() and (candidate / "devtools" / "neqsim_dev_setup.py").exists():
      PROJECT_ROOT = candidate
      break
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)
SystemSrkEos = ns.SystemSrkEos
ProcessSystem = ns.ProcessSystem
Stream = ns.Stream

Do not use from neqsim import jneqsim for task notebooks. That is only for published external-user examples that intentionally target the pip package. Never use raw jpype.startJVM() in new notebooks.

Notebook Structure (Follow This Order)

  1. Title + Introduction (Markdown) — What the notebook demonstrates, prerequisites, ASCII flow diagram if process simulation
  2. Setup and Imports (Code) — All imports in one cell
  3. Fluid Creation (Code) — Create and configure the thermodynamic system
  4. Process/Model Building (Code+Markdown) — Build the flowsheet or model step by step, with explanatory markdown between code cells
  5. Run Simulation (Code) — Single process.run() or equivalent
  6. Results Extraction (Code) — Extract key results into Python variables, display as formatted table with units (use pandas DataFrame or formatted print) 6b. Equipment Feasibility (Code, optional) — For notebooks with compressors or heat exchangers, add a cell running the Design Feasibility Report (see neqsim-api-patterns skill). Show verdict, matching suppliers, and cost estimate.
  7. Visualization (Code) — MANDATORY: At least 2-3 matplotlib figures showing key relationships. Save all figures as PNG. Include axis labels with units, titles, legends, and grids. Common plots: property profiles, composition charts, sensitivity curves, equipment performance, bar charts for comparisons
  8. Summary & Next Steps (Markdown) — Key takeaways and links to related examples

Read the full file on GitHub · 154 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 154 lines · 52 tokens per session scan A cc9a34e75f29

Subscribe to this mod's changes

create a neqsim jupyter notebook is an agent published in the GitHub repository equinor/neqsim (147 stars, last pushed yesterday), licensed Apache-2.0. It adds 52 tokens to every session and 2,058 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.