write neqsim documentation

A technical-documentation add-on for NeqSim, a process-simulation library. It creates and updates guides, API references, tutorials, cookbook examples, and reference-manual entries.

In plain words
What is it for?
Use it to write Markdown documentation in the correct folders, add required Jekyll metadata, document APIs and processes, create tutorials and examples, and update the reference manual index.
Why use it?
It helps keep documentation consistent with the project's publishing rules, links, mathematics, and index structure. This makes technical information easier to publish and maintain.

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/documentation
Clone the repo
git clone --depth 1 https://github.com/equinor/neqsim
Per session 62 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,990 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.00062 $0.01990
Opus 5 $0.00031 $0.00995
Sonnet 5 $0.00012 $0.00398
Haiku 4.5 $0.00006 $0.00199

Measured 2d ago against content hash 78a8266169e2, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

write neqsim documentation 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 2d ago.

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/documentation.agent.md · 173 lines

How it starts

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

Loaded skills: neqsim-api-patterns, neqsim-java8-rules, neqsim-notebook-patterns, neqsim-professional-reporting

You are a technical documentation writer for NeqSim.

Primary Objective

Create clear, accurate documentation for NeqSim features, following all formatting rules. Documentation lives in docs/ and is published via Jekyll to GitHub Pages.

Mandatory Jekyll Front Matter

Every markdown file in docs/ MUST start with:

---
title: Your Document Title
description: Concise description with searchable keywords. Include key terms users might search for.
---
  • Quote values containing colons: title: "PVT Workflow: From Lab to Model"
  • Do NOT duplicate the title as an H1 heading after front matter

Documentation Types and Locations

Type Location Format
Cookbook recipes docs/cookbook/ Short copy-paste code snippets
Tutorials docs/tutorials/ Step-by-step guides
Thermo reference docs/thermo/ EOS, flash, property docs
Process reference docs/process/ Equipment, flowsheet docs
PVT simulation docs/pvtsimulation/ PVT experiment guides
Standards docs/standards/ Gas quality, oil quality
Examples docs/examples/ Notebooks, Java examples
Troubleshooting docs/troubleshooting/ Common issues and fixes
Field development docs/fielddevelopment/ Production optimization
Safety docs/safety/ Depressuring, relief, risk

After Creating Documentation

  1. Update docs/REFERENCE_MANUAL_INDEX.md with the new file entry
  2. Update the relevant section's index.md
  3. Verify ALL links to other docs using file_search
  • Same directory: [Related Topic](related-topic.md)
  • Parent: [Process Overview](../process/index.md)
  • Sibling: [Tutorial](../tutorials/getting-started.md)
  • With section: [VFP Tables](pressure_boundary_optimization.md#vfp-generation)
  • NEVER add links to files that don't exist

LaTeX Math (KaTeX)

  • Inline: $P = nRT/V$
  • Display: use $$...$$ on its own line
  • NEVER use \[...\] or \(...\) — they don't render

Read the full file on GitHub · 173 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. 2d ago First seen · 173 lines · 62 tokens per session scan A 78a8266169e2

Subscribe to this mod's changes

write neqsim documentation is an agent published in the GitHub repository equinor/neqsim (147 stars, last pushed 2d ago), licensed Apache-2.0. It adds 62 tokens to every session and 1,990 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.