The PetroScript book

The whole product in one file: what to call things, which public call writes each deck keyword, a committed worked case for it, and the documentation for every public name. Generated by python tools/build_book.py; do not edit.

PetroScript authors reservoir simulation cases as Python. A model is built from semantic objects — a grid, a rock fabric, fluids, wells, a schedule, the observables you want back — and rendered to a deck. The same deck can be imported back into those objects.

If you already know reservoir simulation, you know it as keywords. Part two converts that: look up the keyword, read the spelling. If you are starting from a word problem instead, read part one and stay on the fluent surface.

The parts

• Part one — the task chapters: the arcs, hand-written and short.
• Part two — the keyword crosswalk: keyword to spelling to worked case.
• Part three — the API reference: every public name, compiled from its own documentation.
• Part four — the house vocabulary: one term per concept.

Two rules this book keeps

It quotes no simulator manual. Where it points at one it points by section number; a page, where one is given, is the number the page’s own footer prints (src/petroscript/eclipse/manual_keyword_index.json, checked against the PDF), never a viewer’s page index, which differs between regions of the document.

It is generated. python tools/build_book.py --check fails on any drift between this file and the tree, so nothing here can quietly go stale — and that includes the hand-written chapters, which are inlined from docs/book/chapters/.