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

Update GitHub documentation before paper publication #135

Open
trevorb1 opened this issue Mar 1, 2022 · 0 comments
Open

Update GitHub documentation before paper publication #135

trevorb1 opened this issue Mar 1, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@trevorb1
Copy link
Member

trevorb1 commented Mar 1, 2022

Now that the Canada-USA paper is closer to publication, there should probably be an effort to improve a few key areas on the repository documentation since its referenced in the paper. Off the top of my head....

  1. Update README.md documentation on each page (Issue Update Readme.MDs to Account for Layout Changes from Pull Request #124 #126)
  2. Review and update the Wiki so there is consistency between the paper and the code (Issue Trade costs wiki documention  #107, Transmission Connection Locations  #106, Naming Convention Page on the WIki #73, Update the Wiki #59)
  3. Update installation and running instructions (which are quite a bit out of date). May be worth it to prioritize issue Add remianing rules for snakemake  #80 to add the remaining pieces to the snakemake workflow.
  4. In the config.yaml file, specify what parameters can and can't be changed. For example, changing the spatial groupings in Canada should be fine (probably deserves a test run though), however, we can't currently change USA spatial groupings due to us still using aggregated data on that.

I probably missed one or two sections that also deserve a review, so this list definitively isnt exhaustive. Im just thinking if readers and researchers arrive on the repository, we should make excellent first impressions! :)

@trevorb1 trevorb1 added the documentation Improvements or additions to documentation label Mar 1, 2022
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

1 participant