This extension brings syntax highlighting to PHREEQC in VSCode. It borrows heavily from the syntax highlighting features from the original Notepad++ version.
After installation, open a .phr file and edit it as you would any scripting language. syntax highlighting will appear and basic language functionality will be available (eg. commenting and indentation). Press Ctrl+F5 to run PHREEQC files directly from VS Code (if installed and added to path). A terminal must be open for the command to execute.
This package does not include a Phreeqc installation. If you need to install PHREEQC,you will have to do it yourself. Both distributions should work:
For Ctrl+F5 execution functionality, PHREEQC must be installed and added to your system PATH. For PhreePlot support (.ppi files), install PhreePlot and ensure pp.exe is accessible in your PATH.
Install it in VSCode marketplace or by downloading the .vsix file from the repository and you are ready to go!
(Example file)
- Press install in the marketplace
or - Download this extension
.vsixfile and follow the following steps:
2.1. Open Visual Studio Code.
2.2. Open the Extensions View:
2.2.1. Click on the Extensions icon in the Activity Bar on the side of the window Alternatively, you can open it by pressing Ctrl+Shift+X.
2.3. Install from VSIX:
2.3.1. Click on the ... (More Actions) button at the top of the Extensions view.
2.3.2. Select Install from VSIX... from the dropdown menu.
2.3.4. Select the .vsix File:
A file dialog will open. Navigate to the directory where your .vsix file is located. Select the .vsix file and click Open. 2.4. Restart Visual Studio Code
PHREEQC output files (.out, .sel) often contain special characters that may display incorrectly with UTF-8 encoding. To ensure proper display:
- Open VS Code Settings (Ctrl+,)
- Search for "encoding"
- Set the following language-specific encoding:
"[phreeqc]": { "files.encoding": "windows1252", "files.autoGuessEncoding": true }
Alternatively, manually change encoding for individual files using the encoding selector in the bottom status bar.
(Example of encoding configuration in VS Code settings)
This extension provides syntax highlighting and execution shortcuts for PHREEQC and PhreePlot files. The execution functionality runs external commands and does not interfere with how PHREEQC or PhreePlot process the scripts. Use it at your own risk. This project is not an official PHREEQC or USGS project, nor it is endorsed by the authors of PHREEQC and related organizations.
When uninstalling this extension, keybindings and syntax highlighting are automatically removed. File encoding settings for .out and .sel files will remain in your VS Code settings. To remove these, go to Settings and search for "encoding" to reset any unwanted defaults.