diff --git a/.github/workflows/deploy-pages.yaml b/.github/workflows/deploy-pages.yaml index 911c31d..0ccd747 100644 --- a/.github/workflows/deploy-pages.yaml +++ b/.github/workflows/deploy-pages.yaml @@ -34,13 +34,13 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Setup Pages uses: actions/configure-pages@v5 - name: Set up Python - uses: actions/setup-python@v4 + uses: actions/setup-python@v6 with: - python-version: '3.11' + python-version: '3.13' - name: Install dependencies run: | sudo apt-get install graphviz graphviz-dev diff --git a/best_practices_report/best_practices.tex b/best_practices_report/best_practices.tex index 2c01d02..505f140 100644 --- a/best_practices_report/best_practices.tex +++ b/best_practices_report/best_practices.tex @@ -1,4 +1,4 @@ -\documentclass[]{nrel} +\documentclass[]{nlr} %%%%% Package options place in square brackets % singleAppendix -- format TOC and appendix chapters without lettering % draft -- add watermark "draft" @@ -53,7 +53,7 @@ \author{Garrett Barter} %<--------- Coauthor's name here \affil{National Renewable Energy Laboratory} %%%%% %<--------- If including authors from multiple institutions, the affiliation number each author needs to be -% \author[1]{Author one} %<--------- other NREL authors +% \author[1]{Author one} %<--------- other NLR authors % \affil[1]{National Renewable Energy Laboratory} % \author[2]{Author two} %<--------- External collaborator % \affil[2]{Another affiliation} %<--------- External collaborator affil diff --git a/best_practices_report/nrel.cls b/best_practices_report/nlr.cls similarity index 88% rename from best_practices_report/nrel.cls rename to best_practices_report/nlr.cls index 18a9bb0..79b0e0f 100644 --- a/best_practices_report/nrel.cls +++ b/best_practices_report/nlr.cls @@ -1,15 +1,15 @@ -% File: nrel.cls v2.0.2, April 2022 +% File: nlr.cls v2.0.2, April 2022 % This class file provides basic functionality for producing -% PDFs that meet NREL's style and formatting requirements. +% PDFs that meet NLR's style and formatting requirements. % ------------------------------------------------------------- % Identification Part % ------------------------------------------------------------- \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{nrel} +\ProvidesClass{nlr} \typeout{ } -\typeout{NREL.cls -- v2.0.4, November 2022} -\typeout{Formats documents according to the NREL style guide} +\typeout{NLR.cls -- v2.0.4, November 2022} +\typeout{Formats documents according to the NLR style guide} \typeout{ } % ------------------------------------------------------------- @@ -26,10 +26,10 @@ % print links in black \newboolean{blacklinks} \setboolean{blacklinks}{false} -% Set flag to meet NREL RAAW requirements +% Set flag to meet NLR RAAW requirements % true by default -\newboolean{IsNREL} -\setboolean{IsNREL}{true} +\newboolean{IsNLR} +\setboolean{IsNLR}{true} % Set flag to meet EERE RAAW requirements \newboolean{IsEERE} \setboolean{IsEERE}{false} @@ -54,15 +54,15 @@ % If EERE option is set, format as EERE RAAW \DeclareOption{EERE}{ \setboolean{IsEERE}{true} - \setboolean{IsNREL}{false} - \def\NREL@class{report} + \setboolean{IsNLR}{false} + \def\NLR@class{report} \typeout{Using EERE report RAAW} } -% NREL is assumed to be true by default +% NLR is assumed to be true by default % unless switched off by EERE flag -\ifthenelse{\boolean{IsNREL}}{ - \def\NREL@class{report} - \typeout{Using NREL report RAAW} +\ifthenelse{\boolean{IsNLR}}{ + \def\NLR@class{report} + \typeout{Using NLR report RAAW} }{} % If tagged option is set, format as tagged pdf \DeclareOption{tagged}{ @@ -83,10 +83,10 @@ % ------------------------------------------------------------- % Process Options % ------------------------------------------------------------- -\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\NREL@class}} +\DeclareOption*{\PassOptionsToClass{\CurrentOption}{\NLR@class}} \ExecuteOptions{12pt} \ProcessOptions\relax -\LoadClass{\NREL@class} +\LoadClass{\NLR@class} % ------------------------------------------------------------- % Package Loading @@ -128,7 +128,7 @@ \RequirePackage[T1]{fontenc} % colours \RequirePackage{xcolor} -\definecolor{nrelblue}{RGB}{0, 121, 193} +\definecolor{nlrblue}{RGB}{0, 121, 193} % set languages \RequirePackage[english]{babel} % To stop hyphenation in titles etc @@ -176,8 +176,8 @@ % \titleformat{\chapter}{\fontsize{18pt}{0pt}\bfseries\selectfont} % \vspace*{12pt} } -% see NREL formatting guidelines at -% https://communications_resources.nrel.gov/style_guide/references +% see NLR formatting guidelines at +% https://communications_resources.nlr.gov/style_guide/references % technical reports \DeclareBibliographyAlias{techreport}{book} % make one type of publication look like another @@ -189,7 +189,7 @@ % -------------------------------------------------------- % Main Code % -------------------------------------------------------- -% NREL default is ragged right. +% NLR default is ragged right. % Load ragged2e so \justifying and environment justify are available. % Redefines \centering, \raggedleft, and \raggedright, and environments center % flushleft and flushright to use versions made by ragged2e. @@ -216,9 +216,9 @@ \renewcommand{\cfttabaftersnum}{.} % title font -\renewcommand{\cfttoctitlefont}{\color{nrelblue} \raggedright \fontsize{18}{6}\sffamily\bfseries} -\renewcommand{\cftloftitlefont}{\color{nrelblue} \raggedright \fontsize{18}{6}\sffamily\bfseries} -\renewcommand{\cftlottitlefont}{\color{nrelblue} \raggedright \fontsize{18}{6}\sffamily\bfseries} +\renewcommand{\cfttoctitlefont}{\color{nlrblue} \raggedright \fontsize{18}{6}\sffamily\bfseries} +\renewcommand{\cftloftitlefont}{\color{nlrblue} \raggedright \fontsize{18}{6}\sffamily\bfseries} +\renewcommand{\cftlottitlefont}{\color{nlrblue} \raggedright \fontsize{18}{6}\sffamily\bfseries} \renewcommand{\cftchapfont}{ \fontsize{10pt}{10pt}\sffamily\bfseries} \renewcommand{\cftsecfont}{ \fontsize{11pt}{11pt}} \renewcommand{\cftsubsecfont}{ \fontsize{11pt}{11pt}} @@ -256,7 +256,7 @@ % Chapter Headings \renewcommand{\@makechapterhead}[1]{% \vspace*{-20\p@}% - {\color{nrelblue} \parindent \z@ \raggedright \normalfont \interlinepenalty\@M + {\color{nlrblue} \parindent \z@ \raggedright \normalfont \interlinepenalty\@M \ifnum \c@secnumdepth >\m@ne \fontfamily{phv} \fontsize{18}{6}\fontseries{b}\selectfont \thechapter \hspace*{1em}#1 @@ -268,7 +268,7 @@ }} \renewcommand{\@makeschapterhead}[1]{% \vspace*{-20\p@}% - {\color{nrelblue} \parindent \z@ \raggedright \normalfont \interlinepenalty\@M + {\color{nlrblue} \parindent \z@ \raggedright \normalfont \interlinepenalty\@M \Large\sffamily\bfseries #1 \par\nobreak % \vspace*{-12pt} @@ -280,17 +280,17 @@ \@startsection{section}{1}{\z@} {-3.25ex \@plus -1ex \@minus -.2ex} {0.25ex \@plus .2ex} - {\color{nrelblue}\fontfamily{phv}\fontsize{14}{14}\fontseries{b}\selectfont}} + {\color{nlrblue}\fontfamily{phv}\fontsize{14}{14}\fontseries{b}\selectfont}} \renewcommand{\subsection}{% \@startsection{subsection}{2}{\z@} {-3.25ex \@plus -1ex \@minus -.2ex} {0.25ex \@plus .2ex} - {\color{nrelblue}\sffamily\normalsize\bfseries\slshape}} + {\color{nlrblue}\sffamily\normalsize\bfseries\slshape}} \renewcommand{\subsubsection}{% \@startsection{subsubsection}{3}{\z@} {-3.25ex \@plus -1ex \@minus -.2ex} {0.25ex \@plus .2ex} - {\color{nrelblue}\sffamily\normalsize\itshape}} + {\color{nlrblue}\sffamily\normalsize\itshape}} \renewcommand{\paragraph}{% \@startsection{paragraph}{4}{\z@} {-3.25ex \@plus -1ex \@minus -.2ex} @@ -386,8 +386,8 @@ \ifthenelse{\boolean{IssingleAppendix}}{ % true \AtBeginEnvironment{appendices}{ - \titleformat{\chapter}{\fontfamily{phv}\fontsize{18}{0}\selectfont\bfseries}{\textcolor{nrelblue} - {Appendix}}{11pt}{\textcolor{nrelblue}} + \titleformat{\chapter}{\fontfamily{phv}\fontsize{18}{0}\selectfont\bfseries}{\textcolor{nlrblue} + {Appendix}}{11pt}{\textcolor{nlrblue}} \titlespacing*{\chapter}{0pt}{-20pt}{0pt} } %<--------- Use this if only one appendix \newcommand{\appchapter}[1]{ @@ -396,8 +396,8 @@ } {% False \AtBeginEnvironment{appendices}{ - \titleformat{\chapter}{\fontfamily{phv}\fontsize{18}{0}\selectfont\bfseries}{\textcolor{nrelblue} - {Appendix \thechapter.}}{11pt}{\textcolor{nrelblue}} + \titleformat{\chapter}{\fontfamily{phv}\fontsize{18}{0}\selectfont\bfseries}{\textcolor{nlrblue} + {Appendix \thechapter.}}{11pt}{\textcolor{nlrblue}} \titlespacing*{\chapter}{0pt}{-20pt}{-6pt} } %<--------- Use this if more than one appendix \newcommand{\appchapter}[1]{ @@ -464,9 +464,9 @@ % colorlinks, % linktoc=all, % linkcolor=black, -% citecolor=nrelblue, +% citecolor=nlrblue, % menucolor=black, -% urlcolor=nrelblue, +% urlcolor=nlrblue, % pdfborder={0 0 0}, % unicode, % pdflang={en-US} @@ -513,35 +513,35 @@ \RequirePackage{fancyhdr} % \fancyhf{} % clear all header and footer fields \ifthenelse{\boolean{IsConfidential}}{%IsConfidential==True - \fancypagestyle{nrel}{% + \fancypagestyle{nlr}{% \fancyhf{} \renewcommand{\headrulewidth}{0pt} \fancyfoot[C]{\thepage\\\vspace{1em} \textbf{The contents of the report are confidential} }} }{%IsConfidential==False - \fancypagestyle{nrel}{% + \fancypagestyle{nlr}{% \fancyhf{} \renewcommand{\headrulewidth}{0pt} - \fancyfoot[C]{\thepage\\\vspace{1em} \fontsize{10pt}{10pt}\sffamily \textcolor{lightgray}{This report is available at no cost from the National Renewable Energy Laboratory (NREL) at \href{www.nrel.gov/publications}{www.nrel.gov/publications}}} + \fancyfoot[C]{\thepage\\\vspace{1em} \fontsize{10pt}{10pt}\sffamily \textcolor{lightgray}{This report is available at no cost from the National Renewable Energy Laboratory (NLR) at \href{www.nlr.gov/publications}{www.nlr.gov/publications}}} } % \renewcommand{\headrulewidth}{0.5pt} % \renewcommand{\headrule}{\hbox to\headwidth{% - % \color{nrelblue}\leaders\hrule height \headrulewidth\hfill}} + % \color{nlrblue}\leaders\hrule height \headrulewidth\hfill}} % \renewcommand{\footrulewidth}{0.5pt} % \renewcommand{\footrule}{\hbox to\headwidth{% - % \color{nrelblue}\leaders\hrule height \headrulewidth\hfill}} -% \thispagestyle{nrel} -% \pagestyle{nrel} + % \color{nlrblue}\leaders\hrule height \headrulewidth\hfill}} +% \thispagestyle{nlr} +% \pagestyle{nlr} } -\appto\frontmatter{\pagestyle{nrel}} -\appto\mainmatter{\pagestyle{nrel}} +\appto\frontmatter{\pagestyle{nlr}} +\appto\mainmatter{\pagestyle{nlr}} \appto\backmatter{\pagestyle{empty}} -% note that the first page of a chapter uses "plain", so we need to redefine that to match the "nrel" page style. -% \let\ps@plain\ps@nrel +% note that the first page of a chapter uses "plain", so we need to redefine that to match the "nlr" page style. +% \let\ps@plain\ps@nlr @@ -569,9 +569,9 @@ colorlinks=false, linktoc=all, linkcolor=black, - citecolor=nrelblue, + citecolor=nlrblue, menucolor=black, - urlcolor=nrelblue, + urlcolor=nlrblue, pdfborder={0 0 0}, unicode, pdflang={en-US}, @@ -601,7 +601,7 @@ \makeatother -%#TODO add ifthenelse statement to change from NREL cover page to EERE cover page +%#TODO add ifthenelse statement to change from NLR cover page to EERE cover page %% THINGS WE NEED TO DO AT THE START OF THE DOCUMENT \AtBeginDocument{ \setlength{\headsep}{6em} diff --git a/docs/_config.yml b/docs/_config.yml index e9b3dbe..64286a4 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -23,7 +23,7 @@ latex: # Information about where the book exists on the web repository: - url: https://github.com/nrel/wetostack + url: https://github.com/natlabrockies/wetostack path_to_book: docs branch: main @@ -45,4 +45,4 @@ sphinx: - 'sphinx_simplepdf' config: html_context: - default_mode: light \ No newline at end of file + default_mode: light diff --git a/docs/_toc.yml b/docs/_toc.yml index 2dd796f..340c916 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -8,7 +8,7 @@ parts: - caption: The Portfolio chapters: - file: portfolio_analysis/overview - - url: https://nrel.github.io/WETOStack/_static/entry_guide/index.html + - url: https://natlabrockies.github.io/WETOStack/_static/entry_guide/index.html title: Entry Guide - file: portfolio_analysis/software_list sections: diff --git a/docs/portfolio_analysis/attributes_schema.md b/docs/portfolio_analysis/attributes_schema.md index b7e2766..3573eff 100644 --- a/docs/portfolio_analysis/attributes_schema.md +++ b/docs/portfolio_analysis/attributes_schema.md @@ -6,18 +6,18 @@ The Portfolio Coordination project is constructing a database of all WETO softwa the portfolio-wide analysis. Initially, only actively-funded software is included, but it will expand to all software under WETO. The database consists of attributes of each software project expressed in a YAML file -in the https://github.com/nrel/wetostack repository. +in the https://github.com/natlabrockies/wetostack repository. The attributes should conform to the JSON schema (YAML is a superset of JSON) described in the documentation below. -See the [FLORIS entry](https://github.com/nrel/WETOStack/blob/main/software_attributes/database/floris.yaml) +See the [FLORIS entry](https://github.com/natlabrockies/WETOStack/blob/main/software_attributes/database/floris.yaml) for an example. To add or update a project entry, submit a pull request to this repository modifying an existing project file or creating a new one. All entries should be in the -[./software_attributes/database](https://github.com/nrel/WETOStack/tree/main/software_attributes/database) +[./software_attributes/database](https://github.com/natlabrockies/WETOStack/tree/main/software_attributes/database) directory. -A [validation script](https://github.com/nrel/WETOStack/blob/main/software_attributes/validate_schema.py) +A [validation script](https://github.com/natlabrockies/WETOStack/blob/main/software_attributes/validate_schema.py) is available, and it is run automatically upon creation and update of the pull request. ````{admonition} How to read the schema docs diff --git a/docs/portfolio_analysis/mind_maps.md b/docs/portfolio_analysis/mind_maps.md index d9e43b8..31951cc 100644 --- a/docs/portfolio_analysis/mind_maps.md +++ b/docs/portfolio_analysis/mind_maps.md @@ -30,8 +30,8 @@ mindmap - OpenFAST https://github.com/openfast/openfast - Multi-physics, multi-fidelity tool for simulating the coupled dynamic response of wind turbines. - FAST.Farm https://github.com/openfast/openfast - Mid-fidelity wind farm simulator that uses OpenFAST as a turbine model. -- MoorPy https://github.com/nrel/moorpy - Quasi-static mooring model and a suite of associated functions for mooring system analysis. -- RAFT https://github.com/WISDEM/RAFT - Library for frequency-domain analysis of floating wind turbines. +- MoorPy https://github.com/natlabrockies/moorpy - Quasi-static mooring model and a suite of associated functions for mooring system analysis. +- RAFT https://github.com/nlrwindsystems/RAFT - Library for frequency-domain analysis of floating wind turbines. - OWENS https://github.com/sandialabs/OWENS.jl - Multi-physics aero-servo-elastic tool with coupling to OpenFAST hydrodynamics and mooring for the coupled dynamic response of VAWTs and crossflow turbines. ```` @@ -91,11 +91,11 @@ mindmap om(" ") ``` -- WEIS https://github.com/wisdem/weis - Wind Energy with Integrated Servo-control performs multifidelity co-design of wind turbines by combining multiple NREL-developed tools to enable design optimization of floating offshore wind turbines. -- WISDEM https://github.com/wisdem/wisdem - Set of wind turbine and plant cost and energy production models along with financial models for assessing overall wind plant cost of energy. -- WindSE https://github.com/nrel/windse - Python package that uses a FEniCS backend to perform wind farm simulations and optimization. -- Ard https://github.com/WISDEM/Ard/ - Make plant-level design choices for the whole system and its interactions to make wind energy projects more successful. -- HOPP https://github.com/NREL/HOPP - Assesses optimal designs for the deployment of utility-scale hybrid energy plants, particularly considering wind, solar and storage. +- WEIS https://github.com/nlrwindsystems/weis - Wind Energy with Integrated Servo-control performs multifidelity co-design of wind turbines by combining multiple NLR-developed tools to enable design optimization of floating offshore wind turbines. +- WISDEM https://github.com/nlrwindsystems/wisdem - Set of wind turbine and plant cost and energy production models along with financial models for assessing overall wind plant cost of energy. +- WindSE https://github.com/natlabrockies/windse - Python package that uses a FEniCS backend to perform wind farm simulations and optimization. +- Ard https://github.com/nlrwindsystems/Ard/ - Make plant-level design choices for the whole system and its interactions to make wind energy projects more successful. +- HOPP https://github.com/natlabrockies/HOPP - Assesses optimal designs for the deployment of utility-scale hybrid energy plants, particularly considering wind, solar and storage. - SONATA https://github.com/ptrbortolotti/SONATA - Toolbox for Multidisciplinary Rotor Blade Design Environment for Structural Optimization and Aeroelastic Analysis. ```` @@ -122,10 +122,10 @@ mindmap om(" ") ``` -- ROSCO https://github.com/NREL/ROSCO - Reference controller with industry-standard functionality and generic tuning -- FLORIS https://github.com/nrel/floris - Controls-focused wind farm simulation software incorporating steady-state engineering wake models into a performance-focused Python framework. -- FLASC https://github.com/nrel/flasc - Suite of analysis tools for SCADA data filtering, analysis, wind farm model validation, field experiment design, and field experiment monitoring. -- hercules https://github.com/nrel/hercules - Wind farm emulator for controls testing with LES models. +- ROSCO https://github.com/natlabrockies/ROSCO - Reference controller with industry-standard functionality and generic tuning +- FLORIS https://github.com/natlabrockies/floris - Controls-focused wind farm simulation software incorporating steady-state engineering wake models into a performance-focused Python framework. +- FLASC https://github.com/natlabrockies/flasc - Suite of analysis tools for SCADA data filtering, analysis, wind farm model validation, field experiment design, and field experiment monitoring. +- hercules https://github.com/natlabrockies/hercules - Wind farm emulator for controls testing with LES models. ```` @@ -148,7 +148,7 @@ mindmap om(" ") ``` -- DW TAP https://github.com/NREL/dw-tap-app - A simple tool for cost-effectively and accurately assessing wind resources without having to physically take direct measurements in the field. +- DW TAP https://github.com/natlabrockies/dw-tap-app - A simple tool for cost-effectively and accurately assessing wind resources without having to physically take direct measurements in the field. ```` @@ -175,10 +175,10 @@ mindmap om(" ") ``` -- LandBOSSE https://github.com/WISDEM/LandBOSSE - 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) -- ORBIT https://github.com/WISDEM/ORBIT - A model to study the cost and times associated with Offshore Wind Balance of System (BOS) processes. -- CORAL https://github.com/NREL/CORAL - Concurrent ORBIT for shared Resource Analysis Library -- NRWAL https://github.com/NREL/NRWAL - A library of offshore wind cost equations (plus new energy technologies like marine hydro!). +- LandBOSSE https://github.com/nlrwindsystems/LandBOSSE - 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) +- ORBIT https://github.com/nlrwindsystems/ORBIT - A model to study the cost and times associated with Offshore Wind Balance of System (BOS) processes. +- CORAL https://github.com/natlabrockies/CORAL - Concurrent ORBIT for shared Resource Analysis Library +- NRWAL https://github.com/natlabrockies/NRWAL - A library of offshore wind cost equations (plus new energy technologies like marine hydro!). ```` @@ -201,7 +201,7 @@ mindmap om(" ") ``` -- SSRS https://github.com/NREL/SSRS - A stochastic agent-based model for predicting raptor movements through an orographic updraft field estimated using the spatially varying wind conditions and ground features (altitude, slope, aspect). +- SSRS https://github.com/natlabrockies/SSRS - A stochastic agent-based model for predicting raptor movements through an orographic updraft field estimated using the spatially varying wind conditions and ground features (altitude, slope, aspect). ```` @@ -225,6 +225,6 @@ mindmap WOMBAT ``` -- WOMBAT https://github.com/WISDEM/WOMBAT - A library to simulate the operation and maintenance phase (O&M) of distributed, land-based, and offshore wind farms using a discrete event simulation framework. -- OpenOA https://github.com/nrel/openoa - A framework for working with large time-series data from wind plants, such as SCADA. +- WOMBAT https://github.com/nlrwindsystems/WOMBAT - A library to simulate the operation and maintenance phase (O&M) of distributed, land-based, and offshore wind farms using a discrete event simulation framework. +- OpenOA https://github.com/natlabrockies/openoa - A framework for working with large time-series data from wind plants, such as SCADA. ```` diff --git a/docs/portfolio_analysis/software_list.md b/docs/portfolio_analysis/software_list.md index b37dc2a..d639cb1 100644 --- a/docs/portfolio_analysis/software_list.md +++ b/docs/portfolio_analysis/software_list.md @@ -3,12 +3,12 @@ # Software Listing While this is intended to be a complete list, it is likely missing some projects. -Please [suggest an edit](https://github.com/nrel/wetostack/edit/main/docs/portfolio_analysis/software_list.md) +Please [suggest an edit](https://github.com/natlabrockies/wetostack/edit/main/docs/portfolio_analysis/software_list.md) if any information here is incorrect. Including if a software in this list requires the following: -- Entry in [software_attributes/database_list.yaml](https://github.com/NREL/WETOStack/blob/main/software_attributes/database_list.yaml) -- Entry in [docs/software_list.md](https://github.com/NREL/WETOStack/blob/main/docs/portfolio_analysis/software_list.md) -- Corresponding YAML file in [software_attributes/database](https://github.com/NREL/WETOStack/tree/main/software_attributes/database) +- Entry in [software_attributes/database_list.yaml](https://github.com/natlabrockies/WETOStack/blob/main/software_attributes/database_list.yaml) +- Entry in [docs/software_list.md](https://github.com/natlabrockies/WETOStack/blob/main/docs/portfolio_analysis/software_list.md) +- Corresponding YAML file in [software_attributes/database](https://github.com/natlabrockies/WETOStack/tree/main/software_attributes/database) All of these tools relate to some aspect of wind energy development from component design and analysis to cost modeling and supply chain analysis. @@ -46,7 +46,7 @@ Select one or a combination of categories to down-select projects.
OpenFAST
FAST.Farm
 -
RAFT
 +
RAFT
OWENS
ExaWind
AMR-Wind
 @@ -54,35 +54,35 @@ Select one or a combination of categories to down-select projects.
kynema
ERF
pyNuMAD
 -
WEIS
 -
WISDEM
 -
Ard
 -
WindSE
 -
HOPP
 -
SONATA
 -
ROSCO
 -
FLORIS
 -
FLASC
 -
hercules
 -
DW TAP
 -
LandBOSSE
 -
ORBIT
 -
WOMBAT
 -
CORAL
 -
NRWAL
 -
OpenOA
 -
SSRS
 -
MoorPy
 -
pCrunch
 -
CCBlade
 -
DrivetrainSE
 -
FixedBottomSE
 -
pyFrame3DD
 -
RotorSE
 -
TowerSE
 -
PlantFinanceSE
 -
PreComp
 -
NREL CSM
 +
WEIS
 +
WISDEM
 +
Ard
 +
WindSE
 +
HOPP
 +
SONATA
 +
ROSCO
 +
FLORIS
 +
FLASC
 +
hercules
 +
DW TAP
 +
LandBOSSE
 +
ORBIT
 +
WOMBAT
 +
CORAL
 +
NRWAL
 +
OpenOA
 +
SSRS
 +
MoorPy
 +
pCrunch
 +
CCBlade
 +
DrivetrainSE
 +
FixedBottomSE
 +
pyFrame3DD
 +
RotorSE
 +
TowerSE
 +
PlantFinanceSE
 +
PreComp
 +
NLR CSM
AeroDyn
BeamDyn
ElastoDyn
 @@ -97,26 +97,26 @@ Select one or a combination of categories to down-select projects.
TurbSim
OpenFAST_IO
Matlab Tools
 -
windtools
 -
dGen
 +
windtools
 +
dGen
dsgrid
 -
REopt
 -
reV
 -
reVX
 -
rex
 -
MAGMA
 -
ReEDS
 -
Super Resolution
 -
Wind Toolkit
 +
REopt
 +
reV
 +
reVX
 +
rex
 +
MAGMA
 +
ReEDS
 +
Super Resolution
 +
Wind Toolkit
``` ## GitHub organizations The following GitHub organizations house some of the software projects supported by WETO: -- https://github.com/nrel +- https://github.com/natlabrockies - https://github.com/exawind - https://github.com/openfast -- https://github.com/wisdem +- https://github.com/nlrwindsystems - https://github.com/erf-model - https://github.com/sandialabs diff --git a/docs/portfolio_analysis/software_other.md b/docs/portfolio_analysis/software_other.md index 25956d7..83df2b8 100644 --- a/docs/portfolio_analysis/software_other.md +++ b/docs/portfolio_analysis/software_other.md @@ -4,32 +4,32 @@ These projects are either funded outside of WETO, are not actively funded, or are deprecated. - KiteFAST: https://github.com/openfast/kitefast -- MAFRIT: https://github.com/NREL/MAFRIT -- pBEAM: https://github.com/WISDEM/pBEAM +- MAFRIT: https://github.com/natlabrockies/MAFRIT +- pBEAM: https://github.com/nlrwindsystems/pBEAM - CACTUS: https://github.com/sandialabs/CACTUS - WEC-Sim/MOST: https://github.com/WEC-Sim/WEC-Sim and http://www.morenergylab.polito.it/most/ -- SOWFA: https://github.com/nrel/sowfa +- SOWFA: https://github.com/natlabrockies/sowfa - NuMAD: https://github.com/sandialabs/NuMAD -- moa_python: https://github.com/nrel/moa_python +- moa_python: https://github.com/natlabrockies/moa_python - MMC-WRF: https://github.com/a2e-mmc/WRF -- G2Aero: https://github.com/NREL/G2Aero -- Gear-SCouP: https://github.com/NREL/GEAR-SCouP -- WISDEM/dakota_driver: https://github.com/WISDEM/dakota_driver -- WPGNN and PLayGen: https://github.com/NREL/WPGNN +- G2Aero: https://github.com/natlabrockies/G2Aero +- Gear-SCouP: https://github.com/natlabrockies/GEAR-SCouP +- WISDEM/dakota_driver: https://github.com/nlrwindsystems/dakota_driver +- WPGNN and PLayGen: https://github.com/natlabrockies/WPGNN - FUSED-Wind: https://github.com/FUSED-Wind/fusedwind -- HybridBOSSE: https://github.com/NREL/HybridBOSSE - A tool for estimating BOS costs for hybrid power plants that share infrastructure. +- HybridBOSSE: https://github.com/natlabrockies/HybridBOSSE - A tool for estimating BOS costs for hybrid power plants that share infrastructure. - ADAMS2AD: The MSC.ADAMS-to-AeroDyn (ADAMS2AD) interface is a software package for simulating the coupled dynamic response of horizontal-axis wind turbines. - BladeFS: Blade Fatigue Static (BladeFS) is a MATLAB script that was developed to determine loads and deflections associated with fatigue and static structural testing of wind turbine blades using matrix based finite element analysis. - HARP_Opt: Horizontal Axis Rotor Performance Optimization (HARP_Opt) utilizes a multiple-objective genetic algorithm and blade-element momentum theory flow model to design horizontal-axis wind and hydrokinetic turbine rotors. -- NAFNoise: NREL AirFoil Noise (NAFNoise) is a program that predicts the noise of any airfoil shape for five different types of noise sources. +- NAFNoise: NLR AirFoil Noise (NAFNoise) is a program that predicts the noise of any airfoil shape for five different types of noise sources. - PROPID: PROP Inverse Design (PROPID) is aerodynamic design software developed by the University of Illinois at Urbana-Champaign. You can use it to design rotors. -- DrivePy: DrivePy is physics-based drivetrain model that sizes drivetrain components based on aerodynamic and operational loads for use in a systems engineering model. It also calculates costs based on empirical data collected by NREL's National Wind Technology Center. +- DrivePy: DrivePy is physics-based drivetrain model that sizes drivetrain components based on aerodynamic and operational loads for use in a systems engineering model. It also calculates costs based on empirical data collected by NLR's National Wind Technology Center. - JacketSE: This is a module for static hydrodynamic, aerodynamic, and structural design and analysis of wind turbine jacket and towers within the Systems Engineering toolbox. - Nacelle Systems Engineering Model and Hub Systems Engineering Model: nacelleSE and hubSE are models that size wind turbine hub system and drivetrain components based on key turbine design parameters and load inputs from a rotor model. - LandOpExSE: This is a cost model for operational expenditures for land-based wind plants. - INN Airfoil Tools: This software package contains code to perform airfoil inverse shape design using a sparsified invertible neural network model. This is a specialized deep learning architecture that enables both network weights to be shared to evaluate forward or inverse passes through the network. As a design tool, this network allows practitioners to specify aerodynamic and structural properties and generate shapes that satisfy those properties. - CREST: Cost of Renewable Energy Spreadsheet Tool -- AirfoilPrep: AirfoilPrep is a preprocessor for generating airfoil tables for AeroDyn. https://github.com/WISDEM/AirfoilPreppy +- AirfoilPrep: AirfoilPrep is a preprocessor for generating airfoil tables for AeroDyn. https://github.com/nlrwindsystems/AirfoilPreppy - BModes: BModes is a finite-element code that provides dynamically coupled modes for a beam. - IECWind: IECWind is a utility program used to create wind files for InflowWind-based programs. - Modes: Modes generates mode shapes for wind turbine towers and blades. @@ -45,12 +45,12 @@ These projects are either funded outside of WETO, are not actively funded, or ar ## Related projects -- CELAVI: https://github.com/NREL/celavi -- CEWAM: https://github.com/NREL/CEWAM -- GDX-pandas: https://github.com/NREL/gdx-pandas -- L-TERRA: https://github.com/NREL/L-TERRA -- NaTGenPD: https://github.com/NREL/NaTGenPD -- OSOS: https://github.com/NREL/osos +- CELAVI: https://github.com/natlabrockies/celavi +- CEWAM: https://github.com/natlabrockies/CEWAM +- GDX-pandas: https://github.com/natlabrockies/gdx-pandas +- L-TERRA: https://github.com/natlabrockies/L-TERRA +- NaTGenPD: https://github.com/natlabrockies/NaTGenPD +- OSOS: https://github.com/natlabrockies/osos - R2PD: https://github.com/Smart-DS/R2PD - Reegle Tagging API (CKAN Extension): https://github.com/REEEP/ckanext-climate-tagger - WindView: https://github.com/windview/client diff --git a/docs/software_dev/developer_resources.md b/docs/software_dev/developer_resources.md index 2deec75..05322a4 100644 --- a/docs/software_dev/developer_resources.md +++ b/docs/software_dev/developer_resources.md @@ -6,10 +6,10 @@ Consider this list a loose collection of resources rather than a comprehensive s This page was written by Rafael Mudafort, and I give my own recommendations and opinions included in the descriptions below. Feel free to reach out to me with questions or comments. -## Internal to NREL +## Internal to NLR -This section section contains training material that was developed at NREL and requires -access to the NREL VPN to view. +This section section contains training material that was developed at NLR and requires +access to the NLR VPN to view. - **Lunch and learn style talks** by Rafael Mudafort given at NWTC between 2019 and 2020 - Some are better than others but all are aimed at new hires, especially interns and post docs. @@ -18,16 +18,16 @@ access to the NREL VPN to view. (command line, ssh, IDE’s, etc). - [OOP with Python](https://web.microsoftstream.com/video/7ef3ea9c-dad9-496d-b9df-927f87b00ca4) - [conda as a development tool](https://web.microsoftstream.com/video/059eaab4-8c1b-4cdb-aa16-c1ed1c081756?list=studio) - - [VS Code as a development tool with NREL-specific tips](https://web.microsoftstream.com/video/202a8a28-80c5-4142-a283-e603134a313f?list=studio) + - [VS Code as a development tool with NLR-specific tips](https://web.microsoftstream.com/video/202a8a28-80c5-4142-a283-e603134a313f?list=studio) - [Basic git usage](https://web.microsoftstream.com/video/6646b872-9e26-44a5-bda9-078d5b3fc65e?list=studio) - Advanced git usage: getting out of a problem (Not recorded but this one should be given again and recorded) - MBAP **Software Engineering for Engineering Software** (SEES) Seminar Series - - [Full list of seminars](https://github.nrel.gov/MBAP/SEES/wiki/Past-Seminars) - - [Git good: Advanced Git and GitHub features](https://github.nrel.gov/MBAP/SEES/wiki/Past-Seminars#git-good-advanced-git-and-github-features) - - [Mutable vs immutable objects and how they impact design and performance in Python](https://github.nrel.gov/MBAP/SEES/wiki/Past-Seminars#mutable-vs-immutable-objects-and-how-they-impact-design-and-performance-in-python) - - [Python Command Line Applications](https://github.nrel.gov/MBAP/SEES/wiki/Past-Seminars#python-command-line-applications) - - [Debugging](https://github.nrel.gov/MBAP/SEES/wiki/Past-Seminars#debugging) + - [Full list of seminars](https://github.nlr.gov/MBAP/SEES/wiki/Past-Seminars) + - [Git good: Advanced Git and GitHub features](https://github.nlr.gov/MBAP/SEES/wiki/Past-Seminars#git-good-advanced-git-and-github-features) + - [Mutable vs immutable objects and how they impact design and performance in Python](https://github.nlr.gov/MBAP/SEES/wiki/Past-Seminars#mutable-vs-immutable-objects-and-how-they-impact-design-and-performance-in-python) + - [Python Command Line Applications](https://github.nlr.gov/MBAP/SEES/wiki/Past-Seminars#python-command-line-applications) + - [Debugging](https://github.nlr.gov/MBAP/SEES/wiki/Past-Seminars#debugging) - Computational Sciences Tutorials - [Teams channel](https://teams.microsoft.com/l/channel/19%3a6nLmPDt9QHQMEuLHVBaxfsitEZSGH6oXT6lyVauMvXY1%40thread.tacv2/General?groupId=22ad3c7b-a45a-4880-b8b4-b70b989f1344&tenantId=a0f29d7e-28cd-4f54-8442-7885aee7c080) diff --git a/docs/workshops/nawea_2023.md b/docs/workshops/nawea_2023.md index f7bbcec..caa6e00 100644 --- a/docs/workshops/nawea_2023.md +++ b/docs/workshops/nawea_2023.md @@ -1,6 +1,6 @@ # 2023 NAWEA / WindTech Workshops -Following the 2023 NAWEA WindTech conference, NREL hosted a series of workshops related to the +Following the 2023 NAWEA WindTech conference, NLR hosted a series of workshops related to the collection of wind energy software produced at the lab. Each workshop introduced a specific software project and provided practical suggestions for modeling and analysis. diff --git a/docs/workshops/nawea_2024.md b/docs/workshops/nawea_2024.md index c485dcf..fdab250 100644 --- a/docs/workshops/nawea_2024.md +++ b/docs/workshops/nawea_2024.md @@ -1,7 +1,7 @@ # 2024 NAWEA / WindTech Workshops Prior to the [2024 NAWEA / WindTech conference](https://naweawindtech2024.org) at -Rutgers University, NREL hosted a [series of workshops](https://naweawindtech2024.org/side-events) +Rutgers University, NLR hosted a [series of workshops](https://naweawindtech2024.org/side-events) related to the collection of wind energy software produced at the lab. Each workshop introduced a specific software project and provided practical suggestions for modeling and analysis. diff --git a/docs/workshops/nawea_2025.md b/docs/workshops/nawea_2025.md index d5d6acc..48afa66 100644 --- a/docs/workshops/nawea_2025.md +++ b/docs/workshops/nawea_2025.md @@ -1,8 +1,8 @@ # 2025 NAWEA / WindTech Workshops Prior to the [2025 NAWEA / WindTech conference](https://naweawindtech2025.org) at -UT Dallas, NREL hosted a [series of workshops](https://naweawindtech2025.org/side-events/) -related to the following software produced by NREL: +UT Dallas, NLR hosted a [series of workshops](https://naweawindtech2025.org/side-events/) +related to the following software produced by NLR: - WEIS - FLORIS - HOPP / H2Integrate diff --git a/docs/workshops/user_workshops_2024.md b/docs/workshops/user_workshops_2024.md index 0ca506a..475bcc2 100644 --- a/docs/workshops/user_workshops_2024.md +++ b/docs/workshops/user_workshops_2024.md @@ -22,7 +22,7 @@ users of WETO software. `````{admonition} Contact :class: tip -Please contact Rafael Mudafort (rafael.mudafort@nrel.gov) with any questions. +Please contact Rafael Mudafort (rafael.mudafort@nlr.gov) with any questions. `````