Creation of a README page

sfbrigade / datasci-SF-Environment-Benchmark

Set of applications to visualize SF building energy consumption and greenhouse gas emissions.

http://old.codeforsanfrancisco.org/datasci-SF-Environment-Benchmark/

12 stars 5 forks source link

Creation of a README page #110

Open gregelin opened 7 years ago

gregelin commented 7 years ago

Hi sfbrigade. I help support the web properties of the San Francisco Department of Environment. It would be great to pull together a README page for this repository if possible.

thfield commented 7 years ago

@gregelin what type of info would be most helpful for you?

gregelin commented 7 years ago

Here is a template for a README https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

It would be useful to explain the purpose of the app, give credit to developers, and to either explain a bit about the data or include a link to a description of the data.

As your audience, I've never looked at the code or the data and only got a quick demo of the UI. Including what you would tell me if I was sitting across a table from you and joint the project at a hackathon would be great.

thfield commented 7 years ago

That's a great template, thanks for pointing it out! I've made some updates to the current README in my latest PR. It might be a little bare-bones, but hopefully contains most of what you're looking for.

gregelin commented 7 years ago

@thfield Great start on the README. Very helpful orienting a new user and helping me get started.

gregelin commented 6 years ago

@thfield I think I need more information on how the code itself works. It appears the http://localhost:8000/dashboard/estar.html?apn=0344/005 refers to a parcel 0344/005, but I am not seeing that value in any of the existing data files in the repository.

It appears that a javascript file (probably a D3 script?) is updating the estar.html, and eui.html, and ghg.html page.

Which javascript is updating the page?
Is the data being pulled by a D3 script from https://data.sfgov.org/Energy-and-Environment/Existing-Commercial-Buildings-Energy-Performance-O/j2j3-acqj a?
Why do certain parcel ids fail, like http://localhost:8000/dashboard/estar.html?apn=4083/001A ?
Can you explain more about what code does what?

thfield commented 6 years ago

@gregelin I've made some more updates to the README which will hopefully help out. I'll work on putting some of these notes throughout the code as comments to clear things up going forward.

gregelin commented 6 years ago

@thfield Thanks. The notes are helpful. Should helpers.getUrlVars() actually be dashboard.getUrlVars()?

thfield commented 6 years ago

I think I put getUrlVars() in helpers instead of Dashboard because that's a function I was planning on reusing for future applications in the scope of this project: maps, other dashboards, etc.

gregelin commented 6 years ago

@thfield I am still running into deployment issues.

Are you planning on merging the 63-refactor-and-modularize branch into main?
What impact does the large #111 merge request have on the code?
What OS have you tested the deployment on?
If I gave you access to a Digital Ocean Droplet, would you be able to set up the server?
You indicated a slack channel and handles, but not a slack domain.

I am in San Francisco the next few days and over the weekend. Would you be available to co-work in order to complete a test deployment?