WEC-Grid is an open-source Python library crafted to simulate the integration of Wave Energy Converters (WECs) with power grid simulators like PSS®E & PyPSA.

Documentation: acep-uaf.github.io/WEC-Grid

We recommend Python 3.9 to match pinned dependencies.

1. Clone the repo

git clone https://github.com/acep-uaf/WEC-Grid
cd WEC-Grid

2. Create and activate a virtual environment

Using Python venv

• macOS (bash/zsh):

  python3 -m venv wecgrid_env
  source wecgrid_env/bin/activate

3. Upgrade pip

python -m pip install --upgrade pip

4. Install WEC‑Grid

pip install -e .

5. Optional (dev tools + tests)

pip install -e .[dev]
pytest -q

Need Windows, Linux, or conda instructions? See the full guide: docs/install.md.

You can configure paths via code or environment variables.

• Database path

  • Quick (env var): set WECGRID_DB_PATH to your SQLite database
    • Windows (PowerShell): $env:WECGRID_DB_PATH = "C:\\path\\to\\WECGrid.db"
    • macOS/Linux (bash/zsh): export WECGRID_DB_PATH=~/path/to/WECGrid.db
  • Persistent (code): engine.database.set_database_path("/path/to/WECGrid.db")
    • This writes a JSON config into your user config directory (e.g., ~/.wecgrid/database_config.json).

• WEC‑Sim path (MATLAB install)

  • Quick (env var): set WECGRID_WECSIM_PATH to the WEC‑Sim folder
  • Persistent (code): engine.wecsim.set_wec_sim_path("/path/to/WEC-Sim")
    • Stored in your user config directory (e.g., ~/.wecgrid/wecsim_config.json).

• Miniconda: Recommended for managing Python versions and binary packages. Download: https://docs.conda.io/en/latest/miniconda.html
• MATLAB + WEC‑Sim: For WEC simulations. Install MATLAB R2021b and WEC‑Sim, then add the MATLAB Engine API for Python to your active environment: https://www.mathworks.com/help/matlab/matlab_external/install-the-matlab-engine-for-python.html
• PSS®E API (Windows): Commercial license required. See: https://new.siemens.com/global/en/products/energy/services/transmission-distribution-smart-grid/consulting-and-planning/pss-software/pss-e.html