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

Add readme #1

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open

Add readme #1

wants to merge 29 commits into from

Conversation

crdanielbusch
Copy link
Collaborator

No description provided.

@crdanielbusch
Copy link
Collaborator Author

@znichollscr can you take a look

Daniel Busch added 2 commits November 28, 2023 12:45
@znichollscr znichollscr self-requested a review November 28, 2023 16:23
Copy link
Collaborator

@znichollscr znichollscr left a comment

Choose a reason for hiding this comment

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

Super nice. Let's discuss a bit tomorrow, maybe clean up a touch more then we can merge and use this as a basis for a copier repository (from which we can then re-create this README to make everything consistent, you'll be a copier pro in no time).

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Owner

@JGuetschow JGuetschow left a comment

Choose a reason for hiding this comment

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

Looks great. Lot's of info that can be used for many repositories. I've also added a few comments

.gitignore Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
crdanielbusch and others added 15 commits November 29, 2023 09:29
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
Co-authored-by: Johannes Gütschow <mail@johannes-guetschow.de>
Co-authored-by: Johannes Gütschow <mail@johannes-guetschow.de>
Co-authored-by: Johannes Gütschow <mail@johannes-guetschow.de>
Co-authored-by: Johannes Gütschow <mail@johannes-guetschow.de>
Co-authored-by: Johannes Gütschow <mail@johannes-guetschow.de>
Copy link
Collaborator

@znichollscr znichollscr left a comment

Choose a reason for hiding this comment

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

Quick test example

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
crdanielbusch and others added 2 commits November 29, 2023 12:01
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
@crdanielbusch
Copy link
Collaborator Author

@JGuetschow @znichollscr thanks for the suggestions. I went through the Readme again and made some small changes. Can you take a look?

Copy link
Collaborator

@znichollscr znichollscr left a comment

Choose a reason for hiding this comment

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

Nice work. There are way more comments and nits than normal because I'm being nit picky because we'll likely re-use this or something like it. Having lots of comments is good practice for you to get used to MRs and reviews, but don't worry you'll probably never have one like this again. (For reference, in future for something like this I would probably just make a MR into your branch to save you clicking so much, but as I said good practice here.)

Nice job. Over to you to accept changes, make other changes, discuss in threads etc. then assign the MR to Johannes for final review and merging.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Daniel Busch and others added 4 commits November 30, 2023 09:44
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "./venv/bin/python3 src/read_version.py --version v230913",
 "dsid": "24f90b12-e4a9-4e2c-995d-a54ed4cd49c7",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [
  "downloaded_data/v230913/0. GCP-CEM.csv"
 ],
 "outputs": [
  "extracted_data/v230913/Robbie_Andrew_Cement_Production_CO2_230913.nc",
  "extracted_data/v230913/Robbie_Andrew_Cement_Production_CO2_230913.yaml",
  "extracted_data/v230913/Robbie_Andrew_Cement_Production_CO2_230913.csv"
 ],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "./venv/bin/python3 src/read_version.py --version v230428",
 "dsid": "24f90b12-e4a9-4e2c-995d-a54ed4cd49c7",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [
  "downloaded_data/v230428/1. Cement_emissions_data.csv"
 ],
 "outputs": [
  "extracted_data/v230428/Robbie_Andrew_Cement_Production_CO2_230428.nc",
  "extracted_data/v230428/Robbie_Andrew_Cement_Production_CO2_230428.yaml",
  "extracted_data/v230428/Robbie_Andrew_Cement_Production_CO2_230428.csv"
 ],
 "pwd": "."
}
^^^ Do not change lines above ^^^
Co-authored-by: znichollscr <114576287+znichollscr@users.noreply.github.com>
@crdanielbusch
Copy link
Collaborator Author

Hi, thank you for your comments. I did the changes in the Readme. I hope I caught all the comments. Let me know if I should change anything else. @znichollscr

@znichollscr
Copy link
Collaborator

All looks good to me. We've made a bit of a mess here, so I would suggest we do a very simple, clean commit on Gin. I'll ping you on slack

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants