Skip to content

Commit

Permalink
Merge branch 'main' into dependabot/pip/jinja2-3.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
nllong committed Jul 25, 2024
2 parents 317db4e + d758ba8 commit 481fca2
Show file tree
Hide file tree
Showing 259 changed files with 1,911 additions and 320 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.7
python-version: 3.8

- name: Install dependencies
run: |
Expand Down
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"cSpell.words": [
"pymdownx",
"superfences"
]
}
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,28 @@ For any issues, please reach out to Katherine Fleming.
* Create a pull request into the `main` branch
* The PR will automatically deploy when merging to `main`.
* If a manual deploy is needed then run `mkdocs gh-deploy`

## Markdown Examples

### Collapsible Sections
To make a section collapsible, you have to remove the `#`s before the section name and replace them with three `?`s. Additionally, you have to add the word `note` and put quotation marks around the section title. For example, change `### Collapsible Sections` to `??? note "Collapsible Sections"`. Finally, the remaining content in that section needs to be indented. See below for an example block of markdown.

```markdown
??? note "Collapsible Sections"
This is the content that is inside the collapsible section.
```

### Image Optimization
Install [pngquant](https://lib.rs/install/pngquant). Once installed run the following commands (these were tested on MacOS):

```BASH
pngquant docs/images/*.png --ext=.png --force
```

```BASH
pngquant docs/images/new/*.png --ext=.png --force
```

```BASH
pngquant docs/images/release_notes/*.png --ext=.png --force
```
21 changes: 21 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# About

## Hosting Options

SEED is a web-based database tool, and therefore must be "hosted" on a web server. It is not designed to be installed on an end-user's desktop computer. There are several options for how SEED can be hosted. The following information will help you select an appropriate type of SEED instance.

If you are a developer, consult the [Developer Getting Started Guide](https://seed-platform.readthedocs.io/en/latest/getting_started.html) for detailed instructions on how to install the SEED Platform locally for development purposes.

### Third-Party Hosting

SEED can be hosted by third-party hosting providers, who will provide access to a SEED account. Providers will be approved and will be responsible for keeping up with the updates to the code. See the Technical Allies page for current hosting providers.

### Self-Hosted

Organizations may want to host their own SEED installation. This requires the SEED source code, installation scripts, and installation instructions, all of which are available in GitHub. Note that SEED is a server-based web application that is not designed to be installed on an end-user's desktop computer. Self-hosting SEED requires some experience with server and database administration and will usually require the involvement of an organization's IT department for installation and operation of a SEED instance.

### Temporary Test Account

We can provide a SEED test account for jurisdictions or organizations that are exploring or in the process of implementing a Building Energy Benchmarking or Building Performance Standard ordinance. For more information, visit the [requesting test Instance](test_instance_request.md) page.


2 changes: 1 addition & 1 deletion docs/developer_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ documentation of classes and methods. General developer resources are found in t

Visit the [Known Issues](known_issues.md) page for a list of SEED Platform issues.

## Futher information
## Further information

There is a developer and a user forum available to receive announcements and discuss features and issues. See the information on the [contact page](contact.md). The development team actively monitors the forums and will respond to inquiries there.
54 changes: 0 additions & 54 deletions docs/documentation.md

This file was deleted.

50 changes: 0 additions & 50 deletions docs/getting_started.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/hosting_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

Hosting providers offer the core open-source functionality of the SEED Platform™ as a hosted service to end-users. The current hosting providers are listed on the [techical ally](technical_ally.md) page.
Hosting providers offer the core open-source functionality of the SEED Platform™ as a hosted service to end-users. The current hosting providers are listed on the [technical ally](technical_ally.md) page.

The purpose of approving hosting providers is to ensure that the SEED Platform trademark is being properly used, and end-users who use a SEED-branded service get the experience and core functionality they expect from the SEED Platform application. The operating principle is that modifications to the core open-source code are not allowed, other than minor modifications needed to register plug-ins or make cosmetic changes for purposes of branding the provider’s service offering.

Expand Down
Binary file modified docs/images/512Matches.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/AT_import_data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/AT_import_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/BETTER_cycle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/BETTER_cycle_allMeterData.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/BETTER_cycle_dateRange.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ClearlyEnergy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Colum Mapping Profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Column Mapping profile 02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Column Settings Matching Fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Cycle create 01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Cycle create 02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/DOE-SEED-Logo_v7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Data - File Import Options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Data Upload 01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Data Upload 02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Data-MappingTax-Property Fields.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/EA-Logo-Color-400x98.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EEEJ_analyses_results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EEEJ_analyses_results_bldg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EEEJ_climateJusticeScreeningTool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EEEJ_inventory_prop_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EEEJ_inventory_prop_map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EEEJ_inventory_prop_results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/EEEJ_runAnalyses.png
Binary file added docs/images/ESPM Add Data File.png
Binary file added docs/images/ESPM Import Options.png
Binary file added docs/images/ESPM Mapping Review.png
Binary file added docs/images/ESPM Mapping.png
Binary file added docs/images/ESPM Matching Results.png
Binary file added docs/images/ESPM Matching progress bar.png
Binary file added docs/images/ESPM Spreadsheet.png
Binary file added docs/images/ESPM Upload a Spreadsheet.png
Binary file added docs/images/ESPM_Import_login-02.png
Binary file added docs/images/ESPM_Import_login.png
Binary file added docs/images/EUI_meterdata_options.png
Binary file added docs/images/Earth Advantage HZ_logo-small.png
Binary file added docs/images/Earth Advantage HZ_logo.png
Binary file added docs/images/Import Data Workflow.png
Binary file added docs/images/Import Data Workflow_300.png
Binary file added docs/images/Map You Data button.png
Binary file added docs/images/Mapping confirmation.png
Binary file added docs/images/Matching progress 01.png
Binary file added docs/images/Multi cycle upload 01.png
Binary file added docs/images/Multi cycle upload 02.png
Binary file added docs/images/OPEN-sm-small200.png
Binary file added docs/images/OPEN-sm-small300.png
Binary file added docs/images/OPEN-sm.png
Binary file added docs/images/SEED-Tools-Interaction-Diagram.png
Binary file added docs/images/Tax Lot Inventory List Tab.png
Binary file added docs/images/Tax Lot Mapping 01.png
Binary file added docs/images/Tax Lot Mapping Review.png
Binary file added docs/images/Tax Lot Property db relationship.png
Binary file added docs/images/Tax Lot mapping matching field.png
Binary file added docs/images/Tax Lot spreadsheet.png
Binary file added docs/images/Tax Lot upload 01.png
Binary file added docs/images/Tax Lot upload 02.png
Binary file added docs/images/Tax Lot upload results.png
Binary file added docs/images/ThirdPartyContributors.png
Binary file added docs/images/aboutScreen.png
Binary file added docs/images/about_termsOfService.png
Binary file added docs/images/analyses_propDetail.png
Binary file added docs/images/analysis_run.png
Binary file added docs/images/api_docExample.png
Binary file added docs/images/beam_logo-small300.png
Binary file modified docs/images/beam_logo.png
Binary file added docs/images/column_list_profiles_01.png
Binary file added docs/images/column_list_profiles_02.png
Binary file added docs/images/column_list_profiles_03.png
Binary file added docs/images/contact_screen.png
Binary file added docs/images/cross_cycle_01.png
Binary file added docs/images/cross_cycle_results.png
Binary file added docs/images/data_dataSets.png
Binary file added docs/images/data_import_multiCycle.png
Binary file added docs/images/data_meter_ESPM_column.png
Binary file added docs/images/data_meter_ESPM_import-01.png
Binary file added docs/images/data_meter_ESPM_import-02.png
Binary file added docs/images/data_meter_ESPM_import-03.png
Binary file added docs/images/data_meter_ESPM_row.png
Binary file added docs/images/data_meter_ESPM_view-01.png
Binary file added docs/images/data_meter_ESPM_view-02.png
Binary file added docs/images/data_meter_ESPM_view-03.png
Binary file added docs/images/data_meter_ESPM_view-04.png
Binary file added docs/images/data_meter_ESPM_view-05.png
Binary file added docs/images/data_meter_GB_import-01.png
Binary file added docs/images/data_meter_GB_import-02.png
Binary file added docs/images/data_meter_displaysettings.png
Binary file added docs/images/data_property_taxlot_relationship.png
Binary file added docs/images/data_upload.png
Binary file added docs/images/data_uploadMeter.png
Binary file added docs/images/documentation_faq.png
Binary file modified docs/images/duplicate_green.png
Binary file modified docs/images/duplicate_red.png
Binary file added docs/images/image19.png
Binary file added docs/images/image23.png
Binary file added docs/images/image25.png
Binary file added docs/images/insights_customReport.png
Binary file added docs/images/insights_default_reports-1000.png
Binary file added docs/images/insights_default_reports-900.png
Binary file added docs/images/insights_default_reports.png
Binary file added docs/images/insights_default_reports_export.png
Binary file added docs/images/insights_overview2insights.png
Binary file added docs/images/insights_programOverview.png
Binary file added docs/images/insights_program_setup_cycles.png
Binary file added docs/images/insights_propertyInsights.png
Binary file added docs/images/insights_propertyInsights_XY.png
Binary file added docs/images/inventory_list_01.png
Binary file added docs/images/inventory_list_02.png
Binary file added docs/images/inventory_list_prop_taxlot_tabs.png
Binary file added docs/images/inventory_list_property_links.png
Binary file added docs/images/inventory_list_taxlot_links.png
Binary file added docs/images/inventory_property-1000.png
Binary file added docs/images/inventory_property-800.png
Binary file added docs/images/inventory_property.png
Binary file added docs/images/inventory_property_auditTemplate.png
Binary file added docs/images/inventory_property_crossCycle.png
Binary file added docs/images/inventory_property_data.png
Binary file added docs/images/inventory_property_detail.png
Binary file added docs/images/inventory_property_detail_UBID-1.png
Binary file added docs/images/inventory_property_detail_UBID-2.png
Binary file added docs/images/inventory_property_detail_UBID-3.png
Binary file added docs/images/inventory_property_detail_UBIDs.png
Binary file added docs/images/inventory_property_detail_links.png
Binary file added docs/images/inventory_property_detail_meters.png
Binary file added docs/images/inventory_property_detail_notes.png
Binary file added docs/images/inventory_property_list_actions.png
Binary file added docs/images/inventory_property_list_filter_02.png
Binary file added docs/images/inventory_property_list_filter_03.png
Binary file added docs/images/inventory_property_list_meters.png
Binary file added docs/images/inventory_property_list_pin.png
Binary file added docs/images/inventory_property_list_sort.png
Binary file added docs/images/inventory_property_noTaxLotSort.png
Binary file added docs/images/inventory_property_summary.png
Binary file added docs/images/labels_create.png
Binary file added docs/images/login_logout_withoutTerms.png
Binary file added docs/images/login_withTerms.png
Binary file modified docs/images/maalka_logo.png
Binary file added docs/images/main_screen.png
Binary file added docs/images/map_01.png
Binary file added docs/images/map_DAC.png
Binary file modified docs/images/mapping_diagram.png
Binary file added docs/images/mapping_property.png
Binary file added docs/images/mcq_int_logo.png
Binary file modified docs/images/mi_logo.png
Binary file added docs/images/navButton_about.png
Binary file added docs/images/navButton_analyses.png
Binary file added docs/images/navButton_apiDocumentation.png
Binary file added docs/images/navButton_contact.png
Binary file added docs/images/navButton_data.png
Binary file added docs/images/navButton_documentation.png
Binary file added docs/images/navButton_insights.png
Binary file added docs/images/navButton_inventory.png
Binary file added docs/images/navButton_logout.png
Binary file added docs/images/navButton_organizations.png
Binary file added docs/images/navigation_bar.png
Binary file added docs/images/new/publicfeed_configure.png
Binary file added docs/images/new/publicfeed_enable.png
Binary file added docs/images/new/publicfeed_json.png
Binary file modified docs/images/ogbs-logo-rough.png
Binary file added docs/images/org_accessLevelTree.png
Binary file added docs/images/org_columnMapping.png
Binary file added docs/images/org_columnSettings.png
Binary file added docs/images/org_cycles.png
Binary file added docs/images/org_dataQuality.png
Binary file added docs/images/org_derivedColumns.png
Binary file added docs/images/org_emailTemplate.png
Binary file added docs/images/org_links.png
Binary file added docs/images/org_members.png
Binary file added docs/images/org_settings.png
Binary file added docs/images/org_settings_Salesforce-1.png
Binary file added docs/images/org_settings_Salesforce-2.png
Binary file added docs/images/org_settings_Salesforce-3.png
Binary file added docs/images/org_settings_Salesforce-4.png
Binary file added docs/images/org_settings_Salesforce-5.png
Binary file added docs/images/property_taxlot_listview.png
Binary file modified docs/images/psd-logo1.png
Binary file modified docs/images/rd100-winner.png
Binary file modified docs/images/release_notes/2_0_image1.png
Binary file modified docs/images/release_notes/2_0_image10.png
Binary file modified docs/images/release_notes/2_0_image11.png
Binary file modified docs/images/release_notes/2_0_image12.png
Binary file modified docs/images/release_notes/2_0_image13.png
Binary file modified docs/images/release_notes/2_0_image2.png
Binary file modified docs/images/release_notes/2_0_image3.png
Binary file modified docs/images/release_notes/2_0_image4.png
Binary file modified docs/images/release_notes/2_0_image5.png
Binary file modified docs/images/release_notes/2_0_image6.png
Binary file modified docs/images/release_notes/2_0_image7.png
Binary file modified docs/images/release_notes/2_0_image8.png
Binary file modified docs/images/release_notes/2_0_image9.png
Binary file modified docs/images/release_notes/ColumnMappings.png
Binary file modified docs/images/release_notes/ColumnSettings.png
Binary file modified docs/images/release_notes/Data-Upload.png
Binary file modified docs/images/release_notes/NewOrgOptions.png
Binary file modified docs/images/release_notes/UBID-ULID-Matching.png
Binary file modified docs/images/release_notes/UploadGeoJSON.png
Binary file modified docs/images/release_notes/data_import.png
Binary file modified docs/images/release_notes/known_issues_2_0.png
Binary file modified docs/images/release_notes/mapping.png
Binary file modified docs/images/release_notes/mapping_review.png
Binary file modified docs/images/release_notes/menu.png
Binary file modified docs/images/release_notes/property_tab_2_0.png
2 changes: 1 addition & 1 deletion docs/known_issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@

- <h3>Number of matches records reported after record matching step is not always accurate</h3>

- Using the sample data (see Knowledge Base for link to a zip file of sample data), after uploading, mapping and matching the two files (tax assessor building list and Energy Star Portfolio Manager data), the program should find 512 matches (the records in both files should have a 100% match). The program should report this value. However, sometimes the program reports a wrong value, but when viewing the matched records in the next step, the correct number of matches will be displayed
- Using the sample data (see Knowledge Base for link to a zip file of sample data), after uploading, mapping and matching the two files (tax assessor building list and Energy Star&reg; Portfolio Manager&reg; data), the program should find 512 matches (the records in both files should have a 100% match). The program should report this value. However, sometimes the program reports a wrong value, but when viewing the matched records in the next step, the correct number of matches will be displayed
![Screenshot of building matches](images/512Matches.png)
4 changes: 4 additions & 0 deletions docs/references.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

## Publications

* Long, N., Fleming, K., Langlois-Romero, I., Henze, G. P., Applegate, S. (2024). ["Equitable Energy Metrics for Integration into Building Performance Standard Tracking Platforms."](./resources/SimBuild2024_SEED_EEEJ.pdf). In IBPSA-USA SimBuild 2024. Denver, CO.

* Bugnion, V., Long, N., Mitchell, R., Bergmann, H., Swindler, A., Beers, E. (2022). ["Building Performance Standards to Drive Market Transformation"](./resources/Bugnion-2022-aceee.pdf). 2022 ACEEE Summer Study on Energy Efficiency in Buildings.

* Long, N., Swindler, A., Bergmann, H., Reagan, A., Held, A., & Longley, J. (2020). ["Standardizing City Benchmarking and Reporting: Use Cases in Consolidating Building Data with SEED"](./resources/Long-2020-Standardizing_City_Benchmarking.pdf), 2020 ACEEE Summer Study on Energy Efficiency in Buildings.
Expand All @@ -23,6 +25,8 @@

## Presentations

* 04/24/2023, NREL/LBNL. [SEED Platform Peer Review Slides](https://www.energy.gov/sites/default/files/2023-05/bto-peer-2023-25204-seed-nrel-long.pdf).

* 11/05/2021. NREL. [SEED Analysis: BETTER, Carbon Metrics,
and EUI Calculations](resources/SEED and BETTER Functionality 2021-11-05.pdf)

Expand Down
Loading

0 comments on commit 481fca2

Please sign in to comment.