Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions .github/workflows/deploy-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions best_practices_report/best_practices.tex
Original file line number Diff line number Diff line change
@@ -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"
Expand Down Expand Up @@ -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
Expand Down
96 changes: 48 additions & 48 deletions best_practices_report/nrel.cls → best_practices_report/nlr.cls
Original file line number Diff line number Diff line change
@@ -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{ }

% -------------------------------------------------------------
Expand All @@ -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}
Expand All @@ -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}{
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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}}
Expand Down Expand Up @@ -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
Expand All @@ -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}
Expand All @@ -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}
Expand Down Expand Up @@ -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]{
Expand All @@ -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]{
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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



Expand Down Expand Up @@ -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},
Expand Down Expand Up @@ -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}
Expand Down
4 changes: 2 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -45,4 +45,4 @@ sphinx:
- 'sphinx_simplepdf'
config:
html_context:
default_mode: light
default_mode: light
2 changes: 1 addition & 1 deletion docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions docs/portfolio_analysis/attributes_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading