Skip to content

Latest commit

 

History

History
69 lines (38 loc) · 4.77 KB

README.md

File metadata and controls

69 lines (38 loc) · 4.77 KB
Raw

OC4IDS Database Notebooks

A collection of notebooks for storing and querying OC4IDS data in a database.

Use the buttons below to open notebooks from the default branch:

Notebook Colab link Description
Download, Check and Import Open In Colab Use this notebook to, download data from OC4IDS publishers, check data using the OC4IDS Data Review Tool and import data and check results into the OC4IDS database.
Delete Collections Open In Colab Use this notebook to delete collections from the database.
Data Feedback Open In Colab Use this notebook to provide feedback on OC4IDS data.
Indicator Coverage Open In Colab Use this notebook to calculate the coverage of the OC4IDS Indicators.
CoST IDS Coverage Open In Colab Use this notebook to calculate the coverage of the CoST Infrastructure Data Standard (IDS), according to the CoST IDS to OC4IDS mapping.

To open a notebook from a different branch, use Colab's Github browser to choose the notebook and branch you want to open.

Alternatively, you can use the Open in Colab browser extension (Chrome, Firefox) to add a button that, when clicked when viewing a Jupyter notebook on github, will open that notebook in Colab.

Database structure

Database structure

Contributing

Edit a copy of a notebook

  1. Open the notebook in Colab.

  2. Make your changes in Colab, following the style guide for SQL statements.

  3. Format any SQL code you add or edit using pgFormatter.

Commit your changes

  1. Create a branch.

In Colab:

  1. Click Edit -> Clear all outputs.

  2. Remove any database credentials you entered into the notebook.

  3. Click File -> Save a copy in Github.

  4. Uncheck 'Include a link to Colaboratory'

  5. Select your branch, enter a commit message and click OK.

Request a review

  1. Create a pull request.

  2. Request a review from a helpdesk analyst.

  3. If the reviewer requests changes, make the changes then repeat this step.

Merge your changes

Once approved, you can merge your changes yourself.

Reviewing

Review changes

Review the changes.

For small changes, you can review the raw diff in the Github review interface.

For larger changes, you can review and comment on a visual diff by clicking the ReviewNB button. You need to authorize the app the first time you open it.