docs(flow-assurance): replace unsafe overview screening - #2920
Merged
Conversation
Replace stale and non-executable screening shortcuts with an evidence-based Java example using the supported hydrate, De Boer, and aqueous scale APIs. Document the engineering boundaries of each result and add focused executable coverage for every demonstrated API call. Refs #2499
12 tasks
EvenSol
marked this pull request as ready for review
August 10, 2026 04:53
This was referenced Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs #2499.
Frozen D048 scope
Rotation scope 5: PVT, flow assurance, standards, and gas/oil quality.
Changed paths:
docs/pvtsimulation/flow_assurance_overview.mdsrc/test/java/neqsim/pvtsimulation/flowassurance/FlowAssuranceDocumentationTest.javaEvidence-only source and tests inspected:
DeBoerAsphalteneScreeningScalePredictionCalculatorThermodynamicOperationsNo open PR found for issue #2499 or this flow-assurance page before publication. PR #2337's fluid-characterization mathematics page and PR #2632's benchmark/reference indexes were explicitly excluded.
Confirmed defects and root cause
The previous overview accumulated unrelated fragments and presented illustrative shortcuts as engineering decisions. The bounded scan confirmed 11 defects: 4 high, 6 medium, 1 low.
High
addTBPfractioncalls supplied molecular weights such as 95–1000 where the API expects kg/mol.Medium
wellStream,fluid, andops.Low
.mdtarget used by this documentation tree.Fix
DeBoerAsphalteneScreeningwith bara and kg/m3 inputs;ScalePredictionCalculatorwith explicit produced-water chemistry in mg/L..mdtargets.Before/after behavior
Before: the page did not provide a reliably executable or technically defensible integrated screen.
After, the exact fenced program compiles and executes with NeqSim 3.17.0 / Java 17.0.19 and returns:
These are case-specific demonstration results; the page explicitly prohibits transferring them to another fluid or water analysis.
Validation
Final checkout is based on current
master60a6bde70de6f0a99b7b59d454e9a936d61d296d.python devtools/run_spotless.py apply— exit 0; rerun exit 0 with unchanged candidate hashes.python devtools/run_spotless.py check— exit 0.python devtools/check_documentation_search.py— exit 0; 647 Markdown pages and 1 standalone HTML page audited.pre-commit run --all-files --hook-stage pre-commit— exit 0; Spotless format passed.pre-commit run --all-files --hook-stage pre-push— exit 0; Spotless check and documentation-search hook passed../mvnw -s .task-maven-settings.xml -o -Dtest=neqsim.pvtsimulation.flowassurance.FlowAssuranceDocumentationTest test— exit 0; 2 tests, 0 failures/errors/skips; 3,146 main and 1,665 test sources compiled../mvnw -s .task-maven-settings.xml -o -Dtest=neqsim.pvtsimulation.flowassurance.ScalePredictionTest test— exit 0; 24 tests, 0 failures/errors/skips.-Dgroups=slow -DexcludedTestGroups=— exit 0; 1 test, 0 failures/errors/skips.Maven used a task-local settings file whose
centralrepository ID points to the canonicalhttps://repo.maven.apache.org/maven2/endpoint. Validation completed from the existing verified local dependency cache because this environment could not resolve public Maven DNS during the first attempt; no repository configuration is included in the commit.Rendering, links, equations, and notebooks
Regression coverage
FlowAssuranceDocumentationTestnow covers every public hydrate and scale API call in the page. The existing De Boer test covers the demonstrated constructor, classification, index, and description. Adjacent scale and slow hydrate reference tests also passed.Next scan
After this PR merges and the ledger records D048 complete, continue D049 with rotation scope 6: process safety, risk, safety-analysis recipes, and standards boundaries.