web: Add support for storage units

dev
Alinson S. Xavier 2 weeks ago
parent fd95cefefc
commit 201dd34b30

@ -20,6 +20,7 @@ import ProfiledUnitsComponent from "./ProfiledUnits";
import ThermalUnitsComponent from "./ThermalUnits";
import TransmissionLinesComponent from "./TransmissionLines";
import { UnitCommitmentScenario } from "../../core/Data/types";
import StorageComponent from "./StorageUnits";
export interface CaseBuilderSectionProps {
scenario: UnitCommitmentScenario;
@ -30,7 +31,13 @@ export interface CaseBuilderSectionProps {
const CaseBuilder = () => {
const [scenario, setScenario] = useState(() => {
const savedScenario = localStorage.getItem("scenario");
return savedScenario ? JSON.parse(savedScenario) : BLANK_SCENARIO;
if (!savedScenario) return BLANK_SCENARIO;
const [processedScenario, err] = preprocess(JSON.parse(savedScenario));
if (err) {
console.log(err);
return BLANK_SCENARIO;
}
return processedScenario!!;
});
const [undoStack, setUndoStack] = useState<UnitCommitmentScenario[]>([]);
const [toastMessage, setToastMessage] = useState<string>("");
@ -112,6 +119,11 @@ const CaseBuilder = () => {
onDataChanged={onDataChanged}
onError={setToastMessage}
/>
<StorageComponent
scenario={scenario}
onDataChanged={onDataChanged}
onError={setToastMessage}
/>
<TransmissionLinesComponent
scenario={scenario}
onDataChanged={onDataChanged}

@ -0,0 +1,235 @@
/*
* UnitCommitment.jl: Optimization Package for Security-Constrained Unit Commitment
* Copyright (C) 2020-2025, UChicago Argonne, LLC. All rights reserved.
* Released under the modified BSD license. See COPYING.md for more details.
*/
import DataTable, {
ColumnSpec,
generateCsv,
generateTableColumns,
generateTableData,
parseCsv,
} from "../Common/Forms/DataTable";
import { CaseBuilderSectionProps } from "./CaseBuilder";
import { useRef } from "react";
import FileUploadElement from "../Common/Buttons/FileUploadElement";
import { ValidationError } from "../../core/Data/validate";
import SectionHeader from "../Common/SectionHeader/SectionHeader";
import SectionButton from "../Common/Buttons/SectionButton";
import {
faDownload,
faPlus,
faUpload,
} from "@fortawesome/free-solid-svg-icons";
import { UnitCommitmentScenario } from "../../core/Data/types";
import { ColumnDefinition } from "tabulator-tables";
import {
changeStorageUnitData,
createStorageUnit,
deleteStorageUnit,
renameStorageUnit,
} from "../../core/Operations/storageOps";
import { offerDownload } from "../Common/io";
export const StorageUnitsColumnSpec: ColumnSpec[] = [
{
title: "Name",
type: "string",
width: 100,
},
{
title: "Bus",
type: "busRef",
width: 100,
},
{
title: "Minimum level (MWh)",
type: "number",
width: 100,
},
{
title: "Maximum level (MWh)",
type: "number",
width: 100,
},
{
title: "Charge cost ($/MW)",
type: "number",
width: 100,
},
{
title: "Discharge cost ($/MW)",
type: "number",
width: 100,
},
{
title: "Charge efficiency",
type: "number",
width: 100,
},
{
title: "Discharge efficiency",
type: "number",
width: 100,
},
{
title: "Loss factor",
type: "number",
width: 80,
},
{
title: "Minimum charge rate (MW)",
type: "number",
width: 140,
},
{
title: "Maximum charge rate (MW)",
type: "number",
width: 140,
},
{
title: "Minimum discharge rate (MW)",
type: "number",
width: 140,
},
{
title: "Maximum discharge rate (MW)",
type: "number",
width: 150,
},
{
title: "Initial level (MWh)",
type: "number",
width: 100,
},
{
title: "Last period minimum level (MWh)",
type: "number",
width: 160,
},
{
title: "Last period maximum level (MWh)",
type: "number",
width: 160,
},
];
export const generateStorageUnitsData = (
scenario: UnitCommitmentScenario,
): [any[], ColumnDefinition[]] => {
const columns = generateTableColumns(scenario, StorageUnitsColumnSpec);
const data = generateTableData(
scenario["Storage units"],
StorageUnitsColumnSpec,
scenario,
);
return [data, columns];
};
const StorageUnitsComponent = (props: CaseBuilderSectionProps) => {
const fileUploadElem = useRef<FileUploadElement>(null);
const onDownload = () => {
const [data, columns] = generateStorageUnitsData(props.scenario);
const csvContents = generateCsv(data, columns);
offerDownload(csvContents, "text/csv", "storage_units.csv");
};
const onUpload = () => {
fileUploadElem.current!.showFilePicker((csv: any) => {
// Parse provided CSV file
const [storageUnits, err] = parseCsv(
csv,
StorageUnitsColumnSpec,
props.scenario,
);
// Handle validation errors
if (err) {
props.onError(err.message);
return;
}
// Generate new scenario
props.onDataChanged({
...props.scenario,
"Storage units": storageUnits,
});
});
};
const onAdd = () => {
const [newScenario, err] = createStorageUnit(props.scenario);
if (err) {
props.onError(err.message);
return;
}
props.onDataChanged(newScenario);
};
const onDelete = (name: string): ValidationError | null => {
const newScenario = deleteStorageUnit(name, props.scenario);
props.onDataChanged(newScenario);
return null;
};
const onDataChanged = (
name: string,
field: string,
newValue: string,
): ValidationError | null => {
const [newScenario, err] = changeStorageUnitData(
name,
field,
newValue,
props.scenario,
);
if (err) {
props.onError(err.message);
return err;
}
props.onDataChanged(newScenario);
return null;
};
const onRename = (
oldName: string,
newName: string,
): ValidationError | null => {
const [newScenario, err] = renameStorageUnit(
oldName,
newName,
props.scenario,
);
if (err) {
props.onError(err.message);
return err;
}
props.onDataChanged(newScenario);
return null;
};
return (
<div>
<SectionHeader title="Storage units">
<SectionButton icon={faPlus} tooltip="Add" onClick={onAdd} />
<SectionButton
icon={faDownload}
tooltip="Download"
onClick={onDownload}
/>
<SectionButton icon={faUpload} tooltip="Upload" onClick={onUpload} />
</SectionHeader>
<DataTable
onRowDeleted={onDelete}
onRowRenamed={onRename}
onDataChanged={onDataChanged}
generateData={() => generateStorageUnitsData(props.scenario)}
/>
<FileUploadElement ref={fileUploadElem} accept=".csv" />
</div>
);
};
export default StorageUnitsComponent;

@ -61,6 +61,25 @@ export const TEST_DATA_1: UnitCommitmentScenario = {
"Flow limit penalty ($/MW)": 5000.0,
},
},
"Storage units": {
su1: {
Bus: "b1",
"Minimum level (MWh)": 10.0,
"Maximum level (MWh)": 100.0,
"Charge cost ($/MW)": 2.0,
"Discharge cost ($/MW)": 1.0,
"Charge efficiency": 0.8,
"Discharge efficiency": 0.85,
"Loss factor": 0.01,
"Minimum charge rate (MW)": 5.0,
"Maximum charge rate (MW)": 10.0,
"Minimum discharge rate (MW)": 4.0,
"Maximum discharge rate (MW)": 8.0,
"Initial level (MWh)": 20.0,
"Last period minimum level (MWh)": 21.0,
"Last period maximum level (MWh)": 22.0,
},
},
};
export const TEST_DATA_2: UnitCommitmentScenario = {
@ -77,6 +96,7 @@ export const TEST_DATA_2: UnitCommitmentScenario = {
},
Generators: {},
"Transmission lines": {},
"Storage units": {},
};
export const TEST_DATA_BLANK: UnitCommitmentScenario = {
@ -89,6 +109,7 @@ export const TEST_DATA_BLANK: UnitCommitmentScenario = {
Buses: {},
Generators: {},
"Transmission lines": {},
"Storage units": {},
};
test("fixtures", () => {});

@ -20,4 +20,5 @@ export const BLANK_SCENARIO: UnitCommitmentScenario = {
Buses: {},
Generators: {},
"Transmission lines": {},
"Storage units": {},
};

@ -45,6 +45,24 @@ export interface TransmissionLine {
"Flow limit penalty ($/MW)": number;
}
export interface StorageUnit {
Bus: string;
"Minimum level (MWh)": number;
"Maximum level (MWh)": number;
"Charge cost ($/MW)": number;
"Discharge cost ($/MW)": number;
"Charge efficiency": number;
"Discharge efficiency": number;
"Loss factor": number;
"Minimum charge rate (MW)": number;
"Maximum charge rate (MW)": number;
"Minimum discharge rate (MW)": number;
"Maximum discharge rate (MW)": number;
"Initial level (MWh)": number;
"Last period minimum level (MWh)": number;
"Last period maximum level (MWh)": number;
}
export interface UnitCommitmentScenario {
Parameters: {
Version: string;
@ -57,6 +75,9 @@ export interface UnitCommitmentScenario {
"Transmission lines": {
[name: string]: TransmissionLine;
};
"Storage units": {
[name: string]: StorageUnit;
};
}
const getTypedGenerators = <T extends any>(

@ -253,6 +253,6 @@ export const assertBusesNotEmpty = (
scenario: UnitCommitmentScenario,
): ValidationError | null => {
if (Object.keys(scenario.Buses).length === 0)
return { message: "Profiled unit requires an existing bus." };
return { message: "This component requires an existing bus." };
return null;
};

@ -20,7 +20,8 @@ export const PREPROCESSING_TEST_DATA_1: any = {
};
test("preprocess", () => {
const newScenario = preprocess(PREPROCESSING_TEST_DATA_1);
const [newScenario, err] = preprocess(PREPROCESSING_TEST_DATA_1);
assert(err === null);
assert.deepEqual(newScenario, {
Parameters: {
Version: "0.4",
@ -35,5 +36,11 @@ test("preprocess", () => {
b2: { "Load (MW)": [10, 10, 10, 10, 10] },
b3: { "Load (MW)": [27.3729, 26.29698, 25.58005, 25.15675, 25.4268] },
},
"Price-sensitive loads": {},
"Storage units": {},
"Transmission lines": {},
Contingencies: {},
Generators: {},
Reserves: {},
});
});

@ -41,6 +41,21 @@ export const preprocess = (
}
}
// Add optional fields
for (let field of [
"Buses",
"Generators",
"Storage units",
"Price-sensitive loads",
"Transmission lines",
"Reserves",
"Contingencies",
]) {
if (!result[field]) {
result[field] = {};
}
}
const scenario = result as unknown as UnitCommitmentScenario;
return [scenario, null];
};

@ -0,0 +1,75 @@
/*
* UnitCommitment.jl: Optimization Package for Security-Constrained Unit Commitment
* Copyright (C) 2020-2025, UChicago Argonne, LLC. All rights reserved.
* Released under the modified BSD license. See COPYING.md for more details.
*/
import { TEST_DATA_1 } from "../Data/fixtures.test";
import assert from "node:assert";
import {
changeStorageUnitData,
createStorageUnit,
deleteStorageUnit,
renameStorageUnit,
} from "./storageOps";
import { ValidationError } from "../Data/validate";
test("createStorageUnit", () => {
const [newScenario, err] = createStorageUnit(TEST_DATA_1);
assert(err === null);
assert.equal(Object.keys(newScenario["Storage units"]).length, 2);
assert("su2" in newScenario["Storage units"]);
});
test("renameStorageUnit", () => {
const [newScenario, err] = renameStorageUnit("su1", "su2", TEST_DATA_1);
assert(err === null);
assert.deepEqual(
newScenario["Storage units"]["su2"],
TEST_DATA_1["Storage units"]["su1"],
);
assert.equal(Object.keys(newScenario["Storage units"]).length, 1);
});
test("changeStorageUnitData", () => {
let scenario = TEST_DATA_1;
let err: ValidationError | null;
[scenario, err] = changeStorageUnitData("su1", "Bus", "b3", scenario);
assert.equal(err, null);
[scenario, err] = changeStorageUnitData(
"su1",
"Minimum level (MWh)",
"99",
scenario,
);
assert.equal(err, null);
[scenario, err] = changeStorageUnitData(
"su1",
"Maximum discharge rate (MW)",
"99",
scenario,
);
assert.equal(err, null);
assert.deepEqual(scenario["Storage units"]["su1"], {
Bus: "b3",
"Minimum level (MWh)": 99.0,
"Maximum level (MWh)": 100.0,
"Charge cost ($/MW)": 2.0,
"Discharge cost ($/MW)": 1.0,
"Charge efficiency": 0.8,
"Discharge efficiency": 0.85,
"Loss factor": 0.01,
"Minimum charge rate (MW)": 5.0,
"Maximum charge rate (MW)": 10.0,
"Minimum discharge rate (MW)": 4.0,
"Maximum discharge rate (MW)": 99.0,
"Initial level (MWh)": 20.0,
"Last period minimum level (MWh)": 21.0,
"Last period maximum level (MWh)": 22.0,
});
});
test("deleteStorageUnit", () => {
const newScenario = deleteStorageUnit("su1", TEST_DATA_1);
assert.equal(Object.keys(newScenario["Storage units"]).length, 0);
});

@ -0,0 +1,98 @@
/*
* UnitCommitment.jl: Optimization Package for Security-Constrained Unit Commitment
* Copyright (C) 2020-2025, UChicago Argonne, LLC. All rights reserved.
* Released under the modified BSD license. See COPYING.md for more details.
*/
import { ValidationError } from "../Data/validate";
import { StorageUnit, UnitCommitmentScenario } from "../Data/types";
import {
assertBusesNotEmpty,
changeData,
generateUniqueName,
renameItemInObject,
} from "./commonOps";
import { StorageUnitsColumnSpec } from "../../components/CaseBuilder/StorageUnits";
export const createStorageUnit = (
scenario: UnitCommitmentScenario,
): [UnitCommitmentScenario, ValidationError | null] => {
const err = assertBusesNotEmpty(scenario);
if (err) return [scenario, err];
const busName = Object.keys(scenario.Buses)[0]!;
const name = generateUniqueName(scenario["Storage units"], "su");
return [
{
...scenario,
"Storage units": {
...scenario["Storage units"],
[name]: {
Bus: busName,
"Minimum level (MWh)": 0,
"Maximum level (MWh)": 1,
"Charge cost ($/MW)": 0.0,
"Discharge cost ($/MW)": 0.0,
"Charge efficiency": 1,
"Discharge efficiency": 1,
"Loss factor": 0,
"Minimum charge rate (MW)": 1,
"Maximum charge rate (MW)": 1,
"Minimum discharge rate (MW)": 1,
"Maximum discharge rate (MW)": 1,
"Initial level (MWh)": 0,
"Last period minimum level (MWh)": 0,
"Last period maximum level (MWh)": 1,
},
},
},
null,
];
};
export const renameStorageUnit = (
oldName: string,
newName: string,
scenario: UnitCommitmentScenario,
): [UnitCommitmentScenario, ValidationError | null] => {
const [newObj, err] = renameItemInObject(
oldName,
newName,
scenario["Storage units"],
);
if (err) return [scenario, err];
return [{ ...scenario, "Storage units": newObj }, null];
};
export const changeStorageUnitData = (
name: string,
field: string,
newValueStr: string,
scenario: UnitCommitmentScenario,
): [UnitCommitmentScenario, ValidationError | null] => {
const [newObj, err] = changeData(
field,
newValueStr,
scenario["Storage units"][name]!,
StorageUnitsColumnSpec,
scenario,
);
if (err) return [scenario, err];
return [
{
...scenario,
"Storage units": {
...scenario["Storage units"],
[name]: newObj as StorageUnit,
},
},
null,
];
};
export const deleteStorageUnit = (
name: string,
scenario: UnitCommitmentScenario,
): UnitCommitmentScenario => {
const { [name]: _, ...newContainer } = scenario["Storage units"];
return { ...scenario, "Storage units": newContainer };
};
Loading…
Cancel
Save