You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35-2Lines changed: 35 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,45 @@ Quickly useful notes:
12
12
- If you reference this package from other workspace packages, keep the `tool.uv.sources` entry that maps `comcheckweb-api-python = { workspace = true }` so `uv` resolves it to the local workspace copy.
13
13
- For a single-package repo you can also rely on `members = ["."]` and omit additional sources, but leaving the explicit source entry is harmless and makes intent clear.
14
14
15
-
## Getting Started
15
+
## Usage
16
+
17
+
### 1. Obtain an API Key
18
+
19
+
Get your API key from [COMcheck Web](https://comcheck.energycode.pnl.gov):
20
+
21
+
1. Log in to your COMcheck Web account
22
+
2. Navigate to **Settings → Developer Setting**
23
+
3. Generate and copy your API key
24
+
25
+
> **Note:** The Developer Setting feature is currently under development.
26
+
27
+
### 2. Configure the API Key
28
+
29
+
Create a `.env` file in your project root (or copy from `.env.example`):
30
+
31
+
```bash
32
+
COM_API_KEY=your-api-key-here
33
+
```
34
+
35
+
### 3. Install the Package
36
+
37
+
```bash
38
+
pip install comcheckweb-api-python
39
+
```
40
+
41
+
### 4. Start Using the Package
42
+
43
+
-**Simulation only:** You can use the simulation features directly without creating a project on COMcheck Web.
44
+
-**Updating a project:** You must first create the project under your account on [COMcheck Web](https://comcheck.energycode.pnl.gov) before using this package to update it. Project creation is not yet supported through this package.
45
+
46
+
For detailed usage examples and API reference, see the [documentation](https://pnnl-int.github.io/comcheckweb-api-python/).
47
+
48
+
## Development
16
49
17
50
Clone the repository and follow the commands below to set up developer tooling.
0 commit comments