Skip to content

Feature: Split the array design save_layout into separate creation and save methods #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RHammond2 merged 4 commits into from
Nov 21, 2025
Merged

Feature: Split the array design save_layout into separate creation and save methods #203

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbb3dc5
slit save_layout to individual creation and save methods
RHammond2 Nov 6, 2025
697239a
update changelog
RHammond2 Nov 6, 2025
6f252c8
merge upstream dev and fix conflicts
RHammond2 Nov 13, 2025
14cfa4b
more useful save log
RHammond2 Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 38 additions & 26 deletions ORBIT/phases/design/array_system_design.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,36 +361,15 @@ def run(self):
self._create_wind_farm_layout()
self._create_cable_section_lengths()

def save_layout(self, save_name, return_df=False, folder="cables"):
"""Outputs a csv of the substation and turbine positional and cable
related components.

Parameters
----------
save_name : str
The name of the file without an extension to be saved to
<library_path>/cables/<save_name>.csv.
return_df : bool, optional
If true, returns layout_df, a pandas.DataFrame of the cabling
layout, by default False.
folder : str, optional
If "cables", then the layout will saved to the "cables" folder, and
if "plant", then the layout will be saved to the "project/plant"
folder.
def create_layout_df(self) -> pd.DataFrame:
"""Creates a Pandas DataFrame layout.

Returns
-------
pd.DataFrame
The DataFrame with the layout data.

Raises
------
ValueError
Raised if ``folder`` is not one of "cables" or "plant".
Wind farm layout compatible with the ``CustomArrayDesignLayout`` or
for use with external models.
"""
if folder not in ("cables", "plant"):
raise ValueError("`folder` must be one of: 'cables' or plant'.")

num_turbines = self.system.num_turbines
columns = [
"id",
Expand Down Expand Up @@ -460,7 +439,40 @@ def save_layout(self, save_name, return_df=False, folder="cables"):
layout_df.cable_length = [""] + self.sections_cable_lengths.flatten()[
:num_turbines
].tolist()
data = [columns] + layout_df.to_numpy().tolist()
return layout_df

def save_layout(self, save_name, return_df=False, folder="cables"):
"""Outputs a csv of the substation and turbine positional and cable
related components.

Parameters
----------
save_name : str
The name of the file without an extension to be saved to
<library_path>/cables/<save_name>.csv.
return_df : bool, optional
If true, returns layout_df, a pandas.DataFrame of the cabling
layout, by default False.
folder : str, optional
If "cables", then the layout will saved to the "cables" folder, and
if "plant", then the layout will be saved to the "project/plant"
folder.

Returns
-------
pd.DataFrame
The DataFrame with the layout data.

Raises
------
ValueError
Raised if ``folder`` is not one of "cables" or "plant".
"""
if folder not in ("cables", "plant"):
Copy link
Collaborator

@nRiccobo nRiccobo Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be folder.lower()?

Copy link
Collaborator Author

@RHammond2 RHammond2 Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only if folder will be converted to lower case first, otherwise it would break later usage with ORBIT. If that's desired, then I can update it.

Copy link
Collaborator

@nRiccobo nRiccobo Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably not the most pressing. It seems like the user would be familiar with the folder names prior to saving anyways...

raise ValueError("`folder` must be one of: 'cables' or plant'.")

layout_df = self.create_layout_df()
data = [layout_df.columns] + layout_df.to_numpy().tolist()
print(
f"Saving custom array CSV to: <library_path>/cables/{save_name}.csv" # noqa: E501
Copy link
Collaborator

@nRiccobo nRiccobo Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{folder}. If folder is set to plant, the print statement would tell me the wrong file location.

Copy link
Collaborator Author

@RHammond2 RHammond2 Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good catch! I didn't really look at this part, but this is a great time to implement more useful logging.

)
Expand Down
27 changes: 15 additions & 12 deletions docs/source/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,25 @@ Unreleased
configuration input.
- Move the matplotlib import from the import section of ``/ORBIT/phases/design/array_system_design.py``
to the ``CustomArraySystemDesign.plot_array_system`` for missing module error handling.
- Adds a general layout ``DataFrame`` creation method as ``ArraySystemDesign.create_layout_df()`` that
is called by the ``save_layout`` method to maintain backwards compatibility, but opens up the ability
gather the layout without saving it to a file.
- Updated default `soft_capex` factors. `PR #201 <https://github.com/WISDEM/ORBIT/pull/201>`_
- `construction_insurance_factor` updated from 0.115 to 0.0207 based on industry benchmarking, resulting in higher construction insurance costs.
- `interest_during_construction` updated from 4.4% to 6.5% based on financial assumptions from the 2025 Annual Technology Baseline (ATB), increasing construction financing costs.
- `decommissioning_factor` updated from 0.175 to 0.2 based on industry benchmarking, leading to higher decommissioning costs than in previous versions.
- `construction_insurance_factor` updated from 0.115 to 0.0207 based on industry benchmarking, resulting in higher construction insurance costs.
- `interest_during_construction` updated from 4.4% to 6.5% based on financial assumptions from the 2025 Annual Technology Baseline (ATB), increasing construction financing costs.
- `decommissioning_factor` updated from 0.175 to 0.2 based on industry benchmarking, leading to higher decommissioning costs than in previous versions.
- Updated default `project_capex` values. `PR #201 <https://github.com/WISDEM/ORBIT/pull/201>`_
- `site_auction_price` increased from 100M to 105M USD to account for rent fees before operation.
- `site_assessment_cost`, `construction_plan_cost`, and `installation_plan_cost` increased from 50M, 1M, and 0.25M USD to 200M, 25M, and 25M USD, respectively.
- Total `project_capex` excluding `site_auction_price` now sums to 250M USD, aligning with DevEx recommendations based on industry benchmarking.
- These updates lead to higher default total project costs than in previous versions.
- `site_auction_price` increased from 100M to 105M USD to account for rent fees before operation.
- `site_assessment_cost`, `construction_plan_cost`, and `installation_plan_cost` increased from 50M, 1M, and 0.25M USD to 200M, 25M, and 25M USD, respectively.
- Total `project_capex` excluding `site_auction_price` now sums to 250M USD, aligning with DevEx recommendations based on industry benchmarking.
- These updates lead to higher default total project costs than in previous versions.
- Included onshore substation costs in BOS CapEx and project breakdown. `PR #201 <https://github.com/WISDEM/ORBIT/pull/201>`_
- The `ElectricalDesign` module previously calculated onshore substation costs but did not include them in `capex_breakdown` or `bos_capex`.
- These costs are now incorporated when `ElectricalDesign` is used, resulting in higher `bos_capex`, `soft_capex`, and `total_capex` than in prior versions.
- The `ElectricalDesign` module previously calculated onshore substation costs but did not include them in `capex_breakdown` or `bos_capex`.
- These costs are now incorporated when `ElectricalDesign` is used, resulting in higher `bos_capex`, `soft_capex`, and `total_capex` than in prior versions.
- Cable configuration file updates. `PR #201 <https://github.com/WISDEM/ORBIT/pull/201>`_
- Added a new dynamic cable configuration file for floating cases: `library/cables/XLPE_1200mm_220kV_dynamic.yaml`.
- Updated cost values for `library/cables/XLPE_630mm_66kV.yaml` and `library/cables/XLPE_630mm_66kV_dynamic.yaml` based on industry benchmarking.
- All cable cost updates are expressed in 2024 USD for consistency with other library configuration files.
- Added a new dynamic cable configuration file for floating cases: `library/cables/XLPE_1200mm_220kV_dynamic.yaml`.
- Updated cost values for `library/cables/XLPE_630mm_66kV.yaml` and `library/cables/XLPE_630mm_66kV_dynamic.yaml` based on industry benchmarking.
- All cable cost updates are expressed in 2024 USD for consistency with other library configuration files.

1.2.4
-----
Expand Down