PyComex VSCode Extension
A Visual Studio Code extension for PyComex - Python Computational Experiments framework.
Features
🧪 Folder Badges for Experiment Archives
Folders named results or archive in your PyComex projects automatically display with a beaker badge (🗃️) and are colored in dark teal, making it easy to identify experiment output directories. This works alongside any existing icon theme you have installed.
▶️ Run Experiment from Config Files
When you open a PyComex experiment configuration YAML file (containing extend: and parameters: fields), a green Run button appears in the top-right corner of the editor - just like when you open a Python file. Click it to run the experiment directly from the editor!
The extension automatically detects and activates your Python virtual environment (.venv, venv, or env) before running the experiment.
Requirements
- Visual Studio Code 1.74.0 or higher
- Python 3.8 or higher
- PyComex installed and available in your PATH (
pip install pycomex)
Installation
From VSCode Marketplace
- Open VS Code
- Press
Ctrl+Shift+X (or Cmd+Shift+X on Mac) to open Extensions
- Search for "PyComex"
- Click Install
From VSIX File
If you have a .vsix file:
code --install-extension pycomex-vscode-0.1.0.vsix
Usage
Running Experiments
- Open any PyComex experiment config YAML file
- Look for the green ▶ Run button in the top-right corner of the editor
- Click the button to run the experiment in a new terminal
The extension will automatically:
- Detect your virtual environment (
.venv, venv, or env)
- Activate the virtual environment
- Run the
pycomex run command
Example config file:
extend: 02_basic.py
parameters:
NUM_WORDS: 500
REPETITIONS: 5
Note: If no virtual environment is found, the command runs directly assuming PyComex is in your system PATH.
Available Commands
Access these via Command Palette (Ctrl+Shift+P):
- PyComex: Run Experiment Config - Run the current PyComex experiment config file
Known Issues
None currently. Please report issues on the PyComex GitHub repository.
Planned Features
Future releases may include:
- Code snippets for common PyComex patterns
- IntelliSense support for experiment decorators
- Sidebar panel for browsing experiments and archives
- Interactive parameter override UI
- Archive viewer with visualization support
Contributing
Contributions are welcome! This extension is part of the PyComex project.
For development setup and technical documentation, see USAGE.md.
Release Notes
0.1.0
Initial release with two core features:
- Folder badges (🗃️) and dark teal coloring for
results and archive directories that work with any icon theme
- Green run button for PyComex experiment config YAML files with automatic virtual environment activation
License
This extension is licensed under the MIT License. See LICENSE.md for details.
Links
Enjoy using PyComex! 🧪
