From 6248b24a1114663fb561006c71f7b77f69a133c7 Mon Sep 17 00:00:00 2001
From: kflemin <2205659+kflemin@users.noreply.github.com>
Date: Thu, 12 Dec 2024 19:34:49 -0700
Subject: [PATCH] linting
---
README.md | 2 +-
cspell.json | 13 ++++++++
docs/release_notes.md | 2 +-
docs/user_doc_analyses.md | 4 +--
docs/user_doc_data_import.md | 6 ++--
docs/user_doc_insights.md | 6 ++--
project-words.txt | 58 ++++++++++++++++++++++++++++++++++++
7 files changed, 81 insertions(+), 10 deletions(-)
create mode 100644 cspell.json
create mode 100644 project-words.txt
diff --git a/README.md b/README.md
index 79428bb6..cc43286f 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Documentation website for the SEED Platform.
This site was generated and deployed using mkdocs.
-## Updating Documention
+## Updating Documentation
* Install Python and PIP
* Install mkdocs `pip install -r requirements.txt`
diff --git a/cspell.json b/cspell.json
new file mode 100644
index 00000000..6475f1a3
--- /dev/null
+++ b/cspell.json
@@ -0,0 +1,13 @@
+{
+ "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+ "version": "0.2",
+ "dictionaryDefinitions": [
+ {
+ "name": "project-words",
+ "path": "./project-words.txt",
+ "addWords": true
+ }
+ ],
+ "dictionaries": ["project-words"],
+ "ignorePaths": ["node_modules", "/project-words.txt", "site", "/mkdocs.yml"]
+}
\ No newline at end of file
diff --git a/docs/release_notes.md b/docs/release_notes.md
index c67e02ec..5a26f0dd 100644
--- a/docs/release_notes.md
+++ b/docs/release_notes.md
@@ -20,7 +20,7 @@ If you have any questions about releases or changes to the program, please conta
**Property Detail**
- - **Audit Template:** It is now possible to upload and download a BuidlingSync or Audit Template file
+ - **Audit Template:** It is now possible to upload and download a BuildingSync or Audit Template file
diff --git a/docs/user_doc_analyses.md b/docs/user_doc_analyses.md
index 7cb66e60..69e886af 100644
--- a/docs/user_doc_analyses.md
+++ b/docs/user_doc_analyses.md
@@ -74,7 +74,7 @@ There are several analyses that can be run on properties. Expand the sections b
??? note "BETTER Analysis"
## BETTER Analysis
- The Building Efficiency Targeting Tool for Energy Retrofits (BETTER) is a software toolkit that enables building operators to quickly and easily identify the most cost-saving eneryg efficiency measures in buildings and portfolios using readily available guilding and eneryg data. For more details, see the [BETTER website](https://better.lbl.gov/).
+ The Building Efficiency Targeting Tool for Energy Retrofits (BETTER) is a software toolkit that enables building operators to quickly and easily identify the most cost-saving energy efficiency measures in buildings and portfolios using readily available building and energy data. For more details, see the [BETTER website](https://better.lbl.gov/).
BETTER can be used to quickly assess the potential energy savings in a building, which then allows users to filter for the buildings with the hightest potential savings, and target those buildings for a more detailed energy audit.
@@ -89,7 +89,7 @@ There are several analyses that can be run on properties. Expand the sections b
**Property Type**
The Property Type must be mapped (for example from the ENERGY STAR Portfolio Manager field called "Property Type - Self Selected") and must be set to a "Space Type" recognized by BETTER.
- See the [BETTER FAQ web page, Building Spaces Types section](https://better.lbl.gov/docs/faq/){:.external}section for the latest space types, as new types are added frequently.
+ See the [BETTER FAQ web page, Building Spaces Types section](https://better.lbl.gov/docs/faq/){:.external} section for the latest space types, as new types are added frequently.
**Address Data**
The Address data for the property must be mapped properly on import, according to the following fields, in order to correctly set the location and weather data that BETTER will use for the analysis.
diff --git a/docs/user_doc_data_import.md b/docs/user_doc_data_import.md
index 9f14145a..04aa98ea 100644
--- a/docs/user_doc_data_import.md
+++ b/docs/user_doc_data_import.md
@@ -212,7 +212,7 @@ The first few steps for importing Property and Tax Parcel data are the same
years defined (based on a field called "Year Ending") the "Multiple
Cycle Upload" box can be checked.
- 
+ 
??? Note "**Upload a Spreadsheet**"
@@ -545,7 +545,7 @@ Meter data associated with a building, both monthly and other time intervals, ca
- **Step 3:** Click the **Upload File** button, browse to the desired GreenButton XML file
- **Step 4:** Click the **Open** button
- 
+ 
- **Step 5:** SEED displays a summary of the GreenButton data
- Click **Confirm** to continue the file upload
@@ -556,7 +556,7 @@ Meter data associated with a building, both monthly and other time intervals, ca
- **Step 9:** The GreenButton data is added to the Meter view in the Property Detail
- **GB** is added as a prefix to the meter number for the GreenButton data
- 
+ 
## **Display Units for Meter Data**
diff --git a/docs/user_doc_insights.md b/docs/user_doc_insights.md
index 0e6b2b34..8b7661c0 100644
--- a/docs/user_doc_insights.md
+++ b/docs/user_doc_insights.md
@@ -28,7 +28,7 @@ Insights can be used to compare metrics for building portfolios or individual bu
- **Custom Reports**
- **Portfolio Summary**
- Below show high level previews of the Insights options. More details are contained in the specific sections for each option.
+ High level previews of the Insights options are shown below. More details are contained in the specific sections for each option.
#### Program Overview
This option shows portfolio compliance with a performance target over time
@@ -64,12 +64,12 @@ Insights can be used to compare metrics for building portfolios or individual bu
- Import metrics (ie, Site EUI or GHG emissions) for each building as well as targets for those metrics
- - Define "drived fields" to calculate target "deltas" if that is useful
+ - Define "derived fields" to calculate target "deltas" if that is useful
### Program Configuration
- Click on the Program Configuration link to define the criteria for these "program" report
+ Click on the Program Configuration link to define the criteria for these "program" reports
There are three components to define on the Program Configuration page:
diff --git a/project-words.txt b/project-words.txt
new file mode 100644
index 00000000..b1dffe6f
--- /dev/null
+++ b/project-words.txt
@@ -0,0 +1,58 @@
+ACEEE
+Alschuler
+Antonoff
+Applegate
+ASHRAE
+Authy
+Aziz
+Balkind
+Beddingfield
+Bergmann
+BRICR
+Bsyncr
+Bugnion
+Cathcart
+CEJST
+Cheifetz
+clearlyenergy
+Duer
+earthadvantage
+EEEJ
+EERE
+ESPM
+Factsheet
+FBBX
+Geocoder
+geocoder
+geospatial
+geospatially
+Goel
+Graw
+HPXML
+IBPSA
+Jaccard
+Langlois
+Lasternas
+LBNL
+Loftness
+Longley
+Macumber
+mkdocs
+NMEC
+NMECR
+NREL
+nrel
+pgdata
+pngquant
+Sharma
+suborganizations
+Supriya
+Syncr
+taxlots
+UBID
+UBIDs
+Uniformat
+unmatch
+unmatching
+Veronique
+Zhang