Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with links to documentation. #51

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md with links to documentation. #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ BuildStockQuery is a python library designed to simplify and streamline the proc

BuildStockQuery offers an intuitive Object-Oriented Programming (OOP) interface to the ResStock output dataset allowing users to easily perform common queries and receive results in familiar pandas DataFrame format, abstracting away the need for complex SQL query. By initializing a query object with the pertinent Athena database and table names, users can easily query for various kinds of insights, for example, timeseries electricity for an end use for a given state grouped by building types.

Documentation and walkthrough: https://github.com/NREL/buildstock-query/wiki

Usage examples: https://github.com/NREL/buildstock-query/tree/main/example_usage
## Documentation

- [Installation and Developer Instructions](https://github.com/NREL/buildstock-query/wiki)
- [Example Usage Notebooks](https://github.com/NREL/buildstock-query/tree/main/example_usage)
- [API and Code Reference](https://nrel.github.io/buildstock-query/)
- [ResStock Project Overview](https://nrel.github.io/ResStock.github.io)