Skip to content

Commit 00f02bd

Browse files
committed
updated README
1 parent 553c4e9 commit 00f02bd

4 files changed

Lines changed: 357 additions & 153 deletions

File tree

README.md

Lines changed: 65 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -11,65 +11,63 @@
1111

1212
---
1313

14-
### Software Setup
15-
16-
#### Optional (but encouraged) Software / Packages
17-
18-
1. **Install Miniconda**
19-
- Miniconda is a minimal installer for conda. It is recommended to manage your Python environments. Helpful for specifying python and other package versions.
20-
- Download and install [Miniconda (64-bit)](https://docs.conda.io/en/latest/miniconda.html) for Python environment management.
21-
22-
2. **MATLAB**
23-
- MATLAB 2021b for running our wave energy converter simulations via WEC-SIM. [Download MATLAB](https://www.mathworks.com/products/matlab.html). This is the only tested and supported version of MATLAB currently. Hold off on installing the MATLAB Engine API for Python until your conda environment is set up.
24-
25-
3. **WEC-SIM**
26-
- Install WEC-SIM. [Get WEC-SIM](https://wec-sim.github.io/WEC-Sim/).
27-
- Expose MATLAB to Python by installing the MATLAB Engine API for Python. Follow instructions [here](https://www.mathworks.com/help/matlab/matlab_external/install-the-matlab-engine-for-python.html). Instructions are also provided below.
28-
29-
4. **PSSe API**
30-
- Obtain and configure the PSSe API. Details and licensing are available on the [PSS®E website](https://new.siemens.com/global/en/products/energy/services/transmission-distribution-smart-grid/consulting-and-planning/pss-software/pss-e.html).
31-
32-
---
33-
34-
### Install
35-
36-
1. Clone WEC-Grid
37-
```bash
38-
git clone https://github.com/acep-uaf/WEC-Grid
39-
```
40-
2. Navigate to the WEC-Grid directory:
41-
```bash
42-
cd WEC-Grid
43-
```
44-
3. Create an environment: (recommended)
45-
```bash
46-
py -3.9 -m venv wecgrid_env
47-
48-
``` or with conda
49-
```bash
50-
conda create --name wecgrid_env python=3.9
51-
```
52-
4. Activate the environment:
53-
```bash
54-
.\wecgrid_env\Scripts\activate
55-
python -m pip install --upgrade pip
56-
57-
``` or with conda
58-
```bash
59-
conda activate wecgrid_env
60-
```
61-
5. Install WEC-Grid!
62-
```bash
63-
pip install -e .
64-
```
65-
6. (Optional) Install extra dependencies
66-
```bash
67-
pip install wecgrid[psse] # PSS®E path helper support
68-
```
69-
7. Run tests
70-
```bash
71-
pytest -v
72-
```
14+
### Quick Install
15+
16+
WEC‑Grid supports Windows, macOS, and Linux. We recommend Python 3.9 to match the pinned dependencies.
17+
18+
1) Clone the repo
19+
```bash
20+
git clone https://github.com/acep-uaf/WEC-Grid
21+
cd WEC-Grid
22+
```
23+
24+
2) Create and activate an environment (pick one)
25+
26+
Using conda (Windows/macOS/Linux):
27+
```bash
28+
conda create -n wecgrid_env python=3.9
29+
conda activate wecgrid_env
30+
```
31+
32+
Using Python venv
33+
- Windows (PowerShell):
34+
```powershell
35+
py -3.9 -m venv wecgrid_env
36+
.\wecgrid_env\Scripts\Activate.ps1
37+
```
38+
- Windows (Command Prompt):
39+
```bat
40+
py -3.9 -m venv wecgrid_env
41+
.\wecgrid_env\Scripts\activate.bat
42+
```
43+
- macOS/Linux (bash/zsh):
44+
```bash
45+
python3 -m venv wecgrid_env
46+
source wecgrid_env/bin/activate
47+
```
48+
49+
3) Upgrade pip
50+
```bash
51+
python -m pip install --upgrade pip
52+
```
53+
54+
4) Install WEC‑Grid
55+
```bash
56+
pip install -e .
57+
```
58+
59+
5) Optional extras
60+
- PSS®E path helper (Windows only):
61+
```bash
62+
pip install -e .[psse]
63+
```
64+
- Dev tools (tests):
65+
```bash
66+
pip install -e .[dev]
67+
pytest -q
68+
```
69+
70+
For more detailed, OS-specific instructions, see `docs/install.md` or the online docs.
7371

7472
---
7573

@@ -88,3 +86,11 @@ You can configure paths via code or environment variables.
8886
- Quick (env var): set `WECGRID_WECSIM_PATH` to the WEC‑Sim folder
8987
- Persistent (code): `engine.wecsim.set_wec_sim_path("/path/to/WEC-Sim")`
9088
- Stored in your user config directory (e.g., `~/.wecgrid/wecsim_config.json`).
89+
90+
---
91+
92+
### Optional Tools
93+
94+
- Miniconda: Recommended for managing Python versions and binary packages. Download: https://docs.conda.io/en/latest/miniconda.html
95+
- 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
96+
- 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

0 commit comments

Comments
 (0)