{"id":13719820,"url":"https://github.com/NREL/NRWAL","last_synced_at":"2025-05-07T11:32:39.767Z","repository":{"id":39744409,"uuid":"319377095","full_name":"NREL/NRWAL","owner":"NREL","description":"The National Renewable Energy Laboratory Wind Analysis Libray (NRWAL)","archived":false,"fork":false,"pushed_at":"2025-04-07T19:54:30.000Z","size":3180,"stargazers_count":19,"open_issues_count":0,"forks_count":12,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-17T23:51:46.536Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nrel.github.io/NRWAL/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NREL.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-07T16:23:18.000Z","updated_at":"2025-03-30T00:47:35.000Z","dependencies_parsed_at":"2024-04-13T20:00:35.237Z","dependency_job_id":"d5022d20-e7e3-42e5-9cb2-024eb92ae9b4","html_url":"https://github.com/NREL/NRWAL","commit_stats":{"total_commits":252,"total_committers":13,"mean_commits":"19.384615384615383","dds":0.5317460317460317,"last_synced_commit":"dc7e65fce35fa24c3152eb208ebb792a6f9a9494"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FNRWAL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FNRWAL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FNRWAL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NREL%2FNRWAL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NREL","download_url":"https://codeload.github.com/NREL/NRWAL/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250439283,"owners_count":21430823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T01:00:56.017Z","updated_at":"2025-05-07T11:32:39.741Z","avatar_url":"https://github.com/NREL.png","language":"Python","funding_links":[],"categories":["Renewable Energy"],"sub_categories":["Wind Energy"],"readme":"*****************\nWelcome to NRWAL!\n*****************\n\n.. image:: https://github.com/NREL/NRWAL/workflows/Documentation/badge.svg\n    :target: https://nrel.github.io/NRWAL/\n\n.. image:: https://github.com/NREL/NRWAL/workflows/Pytests/badge.svg\n    :target: https://github.com/NREL/NRWAL/actions?query=workflow%3A%22Pytests%22\n\n.. image:: https://github.com/NREL/NRWAL/workflows/Lint%20Code%20Base/badge.svg\n    :target: https://github.com/NREL/NRWAL/actions?query=workflow%3A%22Lint+Code+Base%22\n\n.. image:: https://img.shields.io/pypi/pyversions/NREL-NRWAL.svg\n    :target: https://pypi.org/project/NREL-NRWAL/\n\n.. image:: https://badge.fury.io/py/NREL-NRWAL.svg\n    :target: https://badge.fury.io/py/NREL-NRWAL\n\n.. image:: https://anaconda.org/nrel/nrel-NRWAL/badges/version.svg\n    :target: https://anaconda.org/nrel/nrel-NRWAL\n\n.. image:: https://anaconda.org/nrel/nrel-NRWAL/badges/license.svg\n    :target: https://anaconda.org/nrel/nrel-NRWAL\n\n.. image:: https://codecov.io/gh/nrel/NRWAL/branch/main/graph/badge.svg?token=NB29X039VU\n   :target: https://codecov.io/gh/nrel/NRWAL\n\n.. image:: https://zenodo.org/badge/319377095.svg\n   :target: https://zenodo.org/badge/latestdoi/319377095\n\n.. image:: https://mybinder.org/badge_logo.svg\n    :target: https://mybinder.org/v2/gh/NREL/NRWAL/HEAD\n\n\n.. inclusion-intro\n\nThe National Renewable Energy Laboratory Wind Analysis Library (NRWAL):\n\n#. A library of offshore wind cost equations (plus new energy technologies like marine hydro!)\n#. Easy equation manipulation without editing source code\n#. Full continental-scale integration with the NREL Renewable Energy Potential Model (reV)\n#. Ready-to-use configs for basic users\n#. Dynamic python tools for intuitive equation handling\n#. One seriously badass sea unicorn\n\nTo get started with NRWAL, check out the `NRWAL Config documentation \u003chttps://nrel.github.io/NRWAL/_autosummary/NRWAL.handlers.config.NrwalConfig.html#nrwal-handlers-config-nrwalconfig\u003e`_ or the `NRWAL example notebook \u003chttps://github.com/NREL/NRWAL/blob/main/examples/example.ipynb\u003e`_. You can also launch the notebook in an interactive jupyter shell right in your browser without any downloads or software using `binder \u003chttps://mybinder.org/v2/gh/NREL/NRWAL/HEAD\u003e`_. \n\nReady to build a model with NRWAL but don't want to contribute to the library? No problem! Check out the example getting started project `here \u003chttps://github.com/NREL/NRWAL/tree/main/getting_started\u003e`_.\n\nHere is the important stuff:\n\n - `The NRWAL Equation Library \u003chttps://github.com/NREL/NRWAL/tree/main/NRWAL/analysis_library\u003e`_.\n - `Default NRWAL Configs \u003chttps://github.com/NREL/NRWAL/tree/main/NRWAL/default_configs\u003e`_.\n\nInstalling NRWAL\n================\n\nOption 1: Install from PIP or Conda (recommended for analysts):\n---------------------------------------------------------------\n\n1. Create a new environment:\n    ``conda create --name nrwal``\n\n2. Activate directory:\n    ``conda activate nrwal``\n\n3. Install reVX:\n    1) ``pip install NREL-NRWAL`` or\n    2) ``conda install nrel-nrwal --channel=nrel``\n\nOption 2: Clone repo (recommended for developers)\n-------------------------------------------------\n\n1. from home dir, ``git clone https://github.com/NREL/NRWAL.git``\n    1) enter github username\n    2) enter github password\n\n2. Create ``NRWAL`` environment and install package\n    1) Create a conda env: ``conda create -n nrwal``\n    2) Run the command: ``conda activate nrwal``\n    3) cd into the repo cloned in 1.\n    4) prior to running ``pip`` below, make sure the branch is correct (install\n       from master!)\n    5) Install ``NRWAL`` and its dependencies by running:\n       ``pip install .`` (or ``pip install -e .`` if running a dev branch\n       or working on the source code)\n\nNRWAL Variables for Offshore Wind (OSW)\n=======================================\n\n.. list-table:: NRWAL Inputs\n    :widths: auto\n    :header-rows: 1\n\n    * - Variable Name\n      - Long Name\n      - Source\n      - Units\n    * - `aeff`\n      - Array Efficiency\n      - `array_efficiency` input layer, computed from ORBIT\n      - `%`\n    * - `capex_multi`\n      - CAPEX Multiplier\n      - Supplied by user\n      - unit-less\n    * - `depth`\n      - Water depth (positive values)\n      - `bathymetry` input layer\n      - m\n    * - `dist_a_to_s`\n      - Distance from assembly area to site\n      - Computed from `assembly_area` input layer\n      - km\n    * - `dist_op_to_s`\n      - Distance from operating port to site\n      - `ports_operations` input layer\n      - km\n    * - `dist_p_to_a`\n      - Distance from port (construction no-limit) to assembly area\n      - `assembly_area` input layer\n      - km\n    * - `dist_p_to_s`\n      - Distance from construction port to site\n      - `ports_construction` input layer\n      - km\n    * - `dist_p_to_s_nolimit`\n      - Distance from no-limit construction port to site\n      - `ports_construction_nolimit` input layer\n      - km\n    * - `dist_s_to_l`\n      - Distance site to nearest land\n      - `dist_to_coast` input layer\n      - km\n    * - `fixed_downtime`\n      - Average weather downtime for fixed structure turbines\n      - `weather_downtime_fixed_bottom` input layer\n      - fraction\n    * - `floating_downtime`\n      - Average weather downtime for floating structure turbines\n      - `weather_downtime_floating` input layer\n      - fraction\n    * - `gcf`\n      - Gross capacity factor\n      - Computed by reV / SAM with losses == 0\n      - unit-less\n    * - `hs_average`\n      - Significant wave height to determine weather downtime\n      - `weather_downtime_mean_wave_height_buoy` input layer\n      - m\n    * - `num_turbines`\n      - Number of turbines in array\n      - Supplied by user\n      - unit-less\n    * - `transmission_multi`\n      - Tranmission cost multiplier\n      - Supplied by user\n      - unit-less\n    * - `turbine_capacity`\n      - Capacity of each turbine in the array\n      - Supplied by user\n      - MW\n\nRecommended Citation\n====================\n\nIf using the NRWAL software (replace with current version and DOI):\n\n - Grant Buster, Jake Nunemaker, and Michael Rossol. The National Renewable Energy Laboratory Wind Analysis Library (NRWAL). https://github.com/NREL/NRWAL (version v0.0.2), 2021. https://doi.org/10.5281/zenodo.4705961.\n\nIf using the Offshore Wind (OSW) cost equations:\n\n - Beiter, Philipp, Walter Musial, Aaron Smith, Levi Kilcher, Rick Damiani, Michael Maness, Senu Sirnivas, Tyler Stehly, Vahan Gevorgian, Meghan Mooney, and George Scott. “A Spatial-Economic Cost-Reduction Pathway Analysis for U.S. Offshore Wind Energy Development from 2015–2030.” National Renewable Energy Lab. (NREL), Golden, CO (United States), September 1, 2016. https://doi.org/10.2172/1324526. https://www.nrel.gov/docs/fy16osti/66579.pdf.\n\nIf using the marine energy reference model (RM) cost models:\n\n - https://energy.sandia.gov/programs/renewable-energy/water-power/projects/reference-model-project-rmp/\n - Jenne, D. S., Y. H. Yu, and V. Neary. “Levelized Cost of Energy Analysis of Marine and Hydrokinetic Reference Models: Preprint.” National Renewable Energy Lab. (NREL), Golden, CO (United States), April 24, 2015. https://www.osti.gov/biblio/1215196-levelized-cost-energy-analysis-marine-hydrokinetic-reference-models-preprint.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNREL%2FNRWAL","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNREL%2FNRWAL","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNREL%2FNRWAL/lists"}