Skip to content

Commit 3d0cbaf

Browse files
authored
Update README.md
1 parent 49b898a commit 3d0cbaf

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

+20-7
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,38 @@ Example notebooks are found in `/notebooks/` -- a few good overview examples:
2020
## Detailed Documentation
2121
The detailed documentation of how this data set was created can be found in the [repository's wiki](https://github.com/buds-lab/building-data-genome-project-2/wiki) and in the following publication:
2222

23-
### Citation of BDG 2.0 Data-Set
24-
* (Publication)
25-
* (ResearchGate)
26-
* (Bibtex)
23+
### Citation of BDG2 Data-Set
24+
* Publication - Submitted to Scientific Data (coming soon)
25+
* [arXiv](https://arxiv.org/abs/2006.02273)
26+
* [ResearchGate](https://www.researchgate.net/publication/341895125_The_Building_Data_Genome_Project_2_Hourly_energy_meter_data_from_the_ASHRAE_Great_Energy_Predictor_III_competition)
2727

28-
# Publications or Projects that use BDG 2.0 data-set
28+
```
29+
@misc{miller2020building,
30+
title={The Building Data Genome Project 2: Hourly energy meter data from the ASHRAE Great Energy Predictor III competition},
31+
author={Clayton Miller and Anjukan Kathirgamanathan and Bianca Picchetti and Pandarasamy Arjunan and June Young Park and Zoltan Nagy and Paul Raftery and Brodie W. Hobson and Zixiao Shi and Forrest Meggers},
32+
year={2020},
33+
eprint={2006.02273},
34+
archivePrefix={arXiv},
35+
primaryClass={stat.AP}
36+
}
37+
```
38+
39+
# Publications or Projects that use BDG2 data-set
2940
Please update this list if you add notebooks or R-Markdown files to the ``notebook`` folder. Naming convention is a number (for ordering), the creator's initials, and a short `-` delimited description, e.g. `1.0-jqp-initial-data-exploration`.
3041

3142
- (publication here)
3243

3344
## Repository structure
3445
```
3546
building-data-genome-project-2
36-
├─ README.md <- BDG 2.0 README for developers using this data-set
47+
├─ README.md <- BDG2 README for developers using this data-set
3748
└─ data
3849
| ├─metadata <- buildings metadata
3950
| ├─ weather <- weather data
4051
| └─ meters
41-
| └─ raw <- all meter reading datasets, one file for each kind of meter
52+
| └─ raw <- all meter reading datasets
53+
| └─ cleaned <- cleaned meter data based on several filtering steps
54+
| └─ kaggle <- the 2017 meter data that aligns with the Kaggle competition
4255
├─ notebooks <- Jupyter notebooks, named after the naming convention
4356
└─ figures <- figures created during exploration of BDG 2.0 Data-set
4457
```

0 commit comments

Comments
 (0)