-
Notifications
You must be signed in to change notification settings - Fork 40
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.
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
Rewrite sections 1 and 2 of README #209
Conversation
README.md
Outdated
@@ -347,7 +391,7 @@ which sets additional curtailment for particular resource types in all regions. | |||
|
|||
Once we the regional target information and scenario-specific resource |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know the point of this PR was to review Sections 1 and 2, but in skimming the rest of the README, I noticed that there seems to be a word or two missing here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this the only typo you noticed @lsmithiv ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe I called out all the ones I noticed in Sections 1 and 2. In skimming the other sections, nothing jumped out at me, but I could go through them a little more carefully to be sure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thanks for doing this update! We will try to be more conscientious about updating the README when we add/modify features.
1af7aaa
to
00a099e
Compare
I fixed the description of the |
be found at this Dropbox location: | ||
|
||
Dropbox(IVL)\Results\DataAnalysis\RenewablesScalingForScenarios\Clean Energy Capacity Planning Framework.pptx | ||
Dropbox(IVL)/Results/DataAnalysis/RenewablesScalingForScenarios/Clean Energy Capacity Planning Framework.pptx |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once the repository is public, will we still want to refer people to the Dropbox? I know this isn't a problem now, since everything is still internal, I was just curious.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. There should not be any link to Dropbox, private or public. If a file is needed to run a code it should be enclosed in a data folder in the code base and version controlled.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for clarifying
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Damn, I missed the feta folder.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My phone tricked me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not so sure. In my mind, 'feta' is usually a good answer to most questions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nathan has a t-shirt that says pizzas is always the answer. I will get you the feta one then.
Purpose
Rewrite sections 1 and 2 of README.
What is the code doing?
There is no code
Where to look
The README
Time estimate
I cannot really tell. Hopefully my english is not too bad and there is enough information. Feel free to make any corrections and more information.