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

Push and document ERA5 data download and processing files #24

Open
2 of 4 tasks
FanWangEcon opened this issue Aug 29, 2023 · 1 comment
Open
2 of 4 tasks

Push and document ERA5 data download and processing files #24

FanWangEcon opened this issue Aug 29, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@FanWangEcon
Copy link
Member

FanWangEcon commented Aug 29, 2023

To prepare for packaging up and functionalizing existing data input, we want to organize files for downloading and processing ERA5 data, and push code to repository.

Push download downloading and processing code to the Repository. To the Sandbox folder. Feel free to create additional subfolders as needed.

  1. Push key files for downloading ERA5 files.
    • Push file, link to issues
    • Provide simple documentation either in README or in file what the file does, highlight input and output
  2. Push key files for process (averaging) ERA5 files, hourly or dayly aggregations, and ways to select
    • Push file, link to issues
    • Provide simple documentation either in README or in file what the file does, highlight input and output
@FanWangEcon FanWangEcon added the documentation Improvements or additions to documentation label Aug 29, 2023
@FanWangEcon
Copy link
Member Author

FanWangEcon commented Sep 13, 2023

@szkaifeng

Please provide basic information, at the top of each file and inside code blocks, on what:

are separately trying to achieve.

We generally want to document at three spots:

  1. For files in folder, document in README.md for folder, very briefly what each file does
  2. At the top of each file, what the file's objective is
  3. At the start of each code block/segment, what the next block of code does.

Documentation is as important as generating the code itself.

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
Projects
None yet
Development

No branches or pull requests

2 participants