search

edgi-govdata-archiving / ECHO-Cross-Program

Jupyter Notebooks for ECHO that use data from multiple EPA programs
https://colab.research.google.com/github/edgi-govdata-archiving/ECHO-Cross-Program/blob/master/ECHO-Cross-Programs.ipynb
GNU General Public License v3.0
8 stars 5 forks source link

Update readme to better reflect the contents of all of the Notebooks at this repo (and their status) #129

Closed Frijol closed 2 years ago

Frijol commented 2 years ago

There are a lot of Jupyter Notebooks in this repo, not all of which are documented in the readme. This should be clarified for easier use.

To close this issue:

Add a table to the Readme that lists out all the Notebooks in this repo, with columns:

Notebook Name | Description | Status as of (date last checked)

The table should fully replace the current bulleted list in the readme.

  1. Open each Notebook (tip: use Google Colab so you don't have to set up an environment, e.g. https://colab.research.google.com/github/edgi-govdata-archiving/ECHO-Cross-Program/blob/main/AllPrograms2020.ipynb - there's a Chrome extension that can help here).
  2. The Notebook Name should be linked to its Colab link.
  3. Find the description in each each Notebook to add to the table (please paraphrase for brevity).
  4. Click through each Notebook following the instructions it contains. If everything works, set status as Working; otherwise, set it as Errors and note the errors you find as issues in this repo.

Bonus: add issues to this repo with suggestions for improvement to the Notebooks!