Skip to main content

Wind-Plant Integrated System Design & Engineering Model

Project description

LandBOSSE

PyPI version Apache 2.0 image Jupyter Book Badge

Welcome to LandBOSSE!

The Land-based Balance-of-System Systems Engineering (LandBOSSE) model is a systems engineering tool that estimates the balance-of-system (BOS) costs associated with installing utility scale wind plants (10, 1.5 MW turbines or larger). It can execute on macOS and Windows. At this time, for both platforms, it is a command line tool that needs to be accessed from the command line.

The methods used to develop this model (specifically, LandBOSSE Version 2.1.0) are described in greater detail the following report:

Eberle, Annika, Owen Roberts, Alicia Key, Parangat Bhaskar, and Katherine Dykes. 2019. NREL’s Balance-of-System Cost Model for Land-Based Wind. Golden, CO: National Renewable Energy Laboratory. NREL/TP-6A20-72201. https://www.nlr.gov/docs/fy19osti/72201.pdf.

Part of the WETO Stack

LandBOSSE is primarily developed with the support of the U.S. Department of Energy and is part of the WETO Software Stack. For more information and other integrated modeling software, see:

User Guide

Installation

For any installation, users should use a virtual environment. We recommend Miniconda or Anaconda, but any supporting PyPI or source installations are possible. Here, we'll work with conda for compatibility with other NLR tools.

In the below, you can replace the name "landbosse" with any name you choose, and the Python version can be any that you prefer as long as it's supported by LandBOSSE.

conda create -n landbosse python=3.13 -y

PyPI

pip install NREL-landbosse

Source

  1. Navigate to your preferred installation location

  2. Clone the repo (or fork and clone your fork, if preferred).

    git clone https://github.com/NLRWindSystems/LandBOSSE.git
    
  3. Enter the directory and install the local version

    cd LandBOSSE
    pip install .
    

    Optional: pip install -e . for editable installations if you plan to modify the code itself.

First time running the model

At its most basic, the following setup is required, though the provided input data in project_input_template can be used to test out the model and view results before diving into configuring custom scenarios.

  1. Create an input and output folder for LandBOSSE to access. If you are using a source installation, then ensure the folders are not located inside the local copy of the repository.
  2. Create a project_list.xlsx like LandBOSSE/project_list.xlsx and a subfolder called project_data inside of inputs.
  3. Each project in project_list.xlsx should have a corresponding Excel file in project_data similar to the examples in LandBOSSE/project_input_template/project_data.

Running the model

Once the initial steps (above) are followed, we can run the model:

  1. Activate your virtual environment: `conda activate landbosse

  2. Navigate to the top-level LandBOSSE folder

  3. Run the model: python main.py -i input-folder-path -o output-folder-path (be sure to replace "input-folder-path" and "output-folder-path" with your respective input and output folders).

    All together, this is:

    conda activate landbosse
    cd /path/to/LandBOSSE
    python main.py -i /path/to/inputs -o /path/to/outputs
    conda deactivate
    
  4. View your results in the output folder.

Integrating LandBOSSE into your code

While LandBOSSE was originally designed as a CLI tool powered by Excel workbooks, an API also exists to run the model within another application.

Further documentation coming soon

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nrel_landbosse-2.6.3.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nrel_landbosse-2.6.3-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file nrel_landbosse-2.6.3.tar.gz.

File metadata

  • Download URL: nrel_landbosse-2.6.3.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nrel_landbosse-2.6.3.tar.gz
Algorithm Hash digest
SHA256 13bb191df0ef659215995b72715c969ab3a02d1989cd356c29ac7e3af5b47f20
MD5 9fef522bab2c3308e6aedec1a595f419
BLAKE2b-256 34f9bb19bc912fe7f08892858bdc681d7fa44fb6a5ca2d7b8d84b5fd5b1a31ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for nrel_landbosse-2.6.3.tar.gz:

Publisher: python-publish.yml on NLRWindSystems/LandBOSSE

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nrel_landbosse-2.6.3-py3-none-any.whl.

File metadata

  • Download URL: nrel_landbosse-2.6.3-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nrel_landbosse-2.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d6bb196f63812b4099a761af5a6ce2701cac7822f10d6eca5e3d8e11a14adea7
MD5 f349e3b8234ccaefe896dd01791ea331
BLAKE2b-256 7072ef5bf676c1da37e7b8bb1765a2a1aaed7fe5f20e277acfe61356c5475f9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for nrel_landbosse-2.6.3-py3-none-any.whl:

Publisher: python-publish.yml on NLRWindSystems/LandBOSSE

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page