vsHPC-ng

Modern Reservoir Simulation Management & Visualization for VS Code.

vsHPC-ng is a powerful extension designed for reservoir engineers to bridge the gap between their local workspace and High-Performance Computing (HPC) clusters. It streamlines the entire lifecycle of a simulation—from intelligent submission and real-time monitoring to high-fidelity data visualization.

Flagship Feature: High-fidelity SR3 Visualization with adaptive resolution.

🚀 Core Pillars

🛠️ The Engineer's Workflow

Streamline your daily simulation tasks in three simple stages:

1. Configure & Launch

Effortlessly bridge your local models to the HPC cluster. vsHPC-ng uses a dynamic interpolation engine to handle paths, environment variables, and solver parameters. To get started, three mandatory steps are required:

1. Load Configuration: Import your vshpc.json (see the Appendix for schema details).
2. Set SLURM Account: Define your allocation account (the -A parameter).
3. Define Specs: Set your simulation parameters (solver type, core count, version, etc.) via the UI or settings.

Refer to the Appendix for a detailed breakdown of these requirements.

Image: Use the VS Code sidebar menu or Command Palette showcasng vshpc.json loading.

The Context menu helps submit simulations either using an automatic Git clone or locally (legacy), and it can also be used to test your configuration.

Image: Use the VS Code context menu to submit simulations.

2. Monitor & Manage

Keep an eye on your cluster performance without leaving your editor. Track progress percentage (CMG support included), check SLURM states, and open remote logs with a single click.

Image: The Jobs Panel showing active simulations, progress bars, and "Action" buttons.

3. Analyze & Insight

Visualization is the heart of engineering. Turn raw SR3/HDF5 data into interactive charts. Use adaptive resolution for performance, apply custom unit conversions (e.g., bbl/day to m³/day), and save dashboard templates for recurring analysis. Mixing groups, wells and sector on same chart. Export the dataset to CSV to easly import in other tools.

Flagship Feature: High-fidelity SR3 Visualization with adaptive resolution.

✨ Key Features

• SLURM Integration: Full support for job submission, monitoring (squeue), and termination (scancel).
• Git Metadata Tracking: Automatically track which branch or commit hash generated each simulation result.
• Dynamic Macros: Powerful interpolation system (submit.ts) to handle complex cluster directory structures.
• SR3 Viewer Engine:
  • Adaptive Resolution: Automatically switches between month/week/day views for performance.
  • Unit System: Built-in catalog for oil/gas/water units with canonical-to-display conversion.
  • Dashboard Templates: Save your layout (colors, axes, series) and apply it to any new result file.
• File System Bridge: Open remote simulation folders directly in your local Windows Explorer or a new VS Code window via SSH/SCP.
• Unified SR3 Analytics: One-click viewing of results directly from the active Jobs Panel or historical Job Records.

📦 Getting Started

1. Install: Find vshpc-ng in the VS Code Marketplace.
2. Configure: Use the Walkthrough or the Command Palette (Ctrl+Shift+P -> vsHPC: Load Config) to load your vshpc.json.
3. Connect: Set up your SSH credentials in the extension settings.
4. Submit: Right-click any simulation data/dat file and select Submit to HPC.

📖 Appendix: Quick Configuration Guide

Most users will receive a pre-configured vshpc.json from their local HPC support team. Once you have this file, setting up the extension is a simple three-step process:

1. Load your Configuration

Open the VS Code Command Palette (Ctrl+Shift+P on Windows/Linux) and search for: vsHPC: Load Config Select your vshpc.json file. This automatically configures the simulators, remote paths, and cluster connections for you.

2. Set your SLURM Account

In your VS Code Settings (Ctrl+,), search for vshpc.defaultSlurmAccount and enter your allocation account (the -A parameter). This is required for your jobs to be accepted by the cluster scheduler.

3. Simulation Specifications

Before submitting a job, ensure you have selected:

• Solver Type: The simulation engine (e.g., IMEX, OPM, Eclipse).
• Resources: The number of cores and nodes for your job.
• Version: The specific solver version installed on the cluster.

Need help? Check with your local HPC support team for a compatible vshpc.json file.