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.

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

updated hsc_data_documentation #63

Merged
merged 6 commits into from
Oct 15, 2022

Conversation

shakesy94
Copy link
Collaborator

@shakesy94 shakesy94 commented Sep 26, 2022

draft pull request

Adding HSC output documentation to HSC_data_documentation.md

@Betristor I know you have been working on this file. @anna-nadia and I can take this to completion so no need to work on section 3 of HSC_data_documentation.md. if you would like to add or edit this file, would appreciate it if you do it on this branch.

@shakesy94 shakesy94 added the wip label Sep 26, 2022
@Betristor Betristor added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 26, 2022
@Betristor
Copy link
Collaborator

@shakesy94 It's OK to edit any file of documentation part. As stated in the PR #46, commits are welcome.

@shakesy94
Copy link
Collaborator Author

shakesy94 commented Sep 26, 2022

@Betristor Yes, appreciate your work on this! Just meant that you can prioritize other things if you'd like because I have this on my radar. Feel free to continue to contribute to this if you'd like!

Created a separate branch/PR because I think it is better practice to compartmentalize PRs. Having many people work on the same documentation branch can result in more conflicts.

@Betristor Betristor self-assigned this Sep 26, 2022
@Betristor
Copy link
Collaborator

compartmentalize

@shakesy94 Yes, that's very efficient when many people are in cooperation on the same work. I apreciate your work on updating hsc_data_documantation, I will put my focus on modifying notaion part including genx_notation.md and hsc_notation.md files.

Copy link
Collaborator

@anna-nadia anna-nadia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused why I'm asked to review this if it's only like 10% complete? Do you expect me to fill out the rest?

still needs trucks, not sure about pipe flow source and sink.
#### 3.2.5 HSC_h2_pipeline_flow.csv

Reports H2 level (in tonnes/hour) in each pipeline for each time step, as well as the amount of hydrogen (in tonnes) sent from the source or arrived at the sink.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not sure about the meaning of the source and sink columns

@Betristor Betristor requested a review from anna-nadia October 5, 2022 02:38
@Betristor
Copy link
Collaborator

I'm confused why I'm asked to review this if it's only like 10% complete? Do you expect me to fill out the rest?

@anna-nadia Hi, anna, I implemented truck's description on this branch, would you please review the changes?

@Betristor Betristor merged commit 1c10e87 into main_doc_rewrite Oct 15, 2022
@RuaridhMacd RuaridhMacd deleted the update_update_hsc_data_documentation branch January 29, 2024 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers wip
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants