GGIRCS

BC Climate Action Secretariat's Greenhouse Gas Industrial Reporting and Control System.
https://github.com/bcgov/cas-ggircs

Category: Emissions
Sub Category: Carbon Intensity and Accounting

Keywords

cas-ggircs dds env

Keywords from Contributors

citz

Last synced: about 20 hours ago
JSON representation

Repository metadata

Climate Action Secretariat's Greenhouse Gas Industrial Reporting and Control System

Readme.md

Welcome to GGIRCS

GGIRCS stands for Greenhouse Gas Industrial Reporting and Control System for the Climate Action Secretariat (CAS).

Description

GGIRCS is a tool designed to modernize the annual reporting and verification of greenhouse gas industrial emissions. This project is a fulfillment to meet the requirements of the BC government initiatives including Climate Strategy, Clean Growth and CleanBC, part of the Greenhouse Gas Industrial Reporting and Control Act [GGIRCA].

Status

  • Master Pipeline: CircleCI

  • Develop Pipeline:

  • Functional Test:

Usage

Release procedure

Clone repository

In terminal:

  • Run make verify to ensure minimum required versions of all dependencies are installed and postgres is online (see the dependencies section below)

  • Run make install to set up a development environment

  • Run make test to execute all pgTAP-based tests against a ggircs_test database

  • If needed, create a development database using $ createdb ggircs

  • Run sqitch deploy to deploy to a ggircs database

Using Sqitch


If you're new to Sqitch, the best place to start is with the tutorial and other docs.

Add Schema

  • sqitch add schema_[schema_name]

Add Table

  • sqitch add table*[table_name] --require schema*[schema_name] --set schema=[schema_name]

Dependencies


PostgreSQL

Installation

Version 10 or higher recommended. Usually available via your distribution's package system. Binaries and source are also available for download. The PostgreSQL wiki has a list of detailed installation guides where you can find some OS-specific instructions.

A role/user with the following options must be created (see this tutorial if you need information on how to create roles):

  • The role name is your current user name ($ whoami)

  • The role has the SUPERUSER option

Git

1.7.0 or higher recommended. Usually available via your distribution's package system. Binaries and source are also available for download.

Perl

5.10.0 or higher. Included in most Unix distributions and on OS X. Windows users can install ActivePerl. The Perl website has OS-specific installation instructions.

Data

Excluding Test Data

The data-set that is parsed by the ETL process includes some test data that needs to be excluded from the actual data housed in the swrs schema. This is achieved in swrs/transform/table/ignore_organisation by adding the swrs_organisation_id of organisations that were created for test purposes to this table. A join on this table in the swrs/transform/view/final_report view then ignores these organisations when loading data into the final schema.

Data Architecture

(TBC)

Project Material Publication

The materials published include:

  • Code Repositories
  • /bcgov/cas-airflow-dags
  • /bcgov/cas-ciip-portal
  • /bcgov/cas-docker-metabase
  • /bcgov/cas-docker-sqitch
  • /bcgov/cas-ggircs
  • /bcgov/cas-ggircs-ciip-2018-extract
  • /bcgov/cas-ggircs-ciip-2018-schema
  • /bcgov/cas-ggircs-metabase
  • /bcgov/cas-ggircs-metabase-build
  • /bcgov/cas-ggircs-metabase-builder
  • /bcgov/cas-helm
  • /bcgov/cas-metascript
  • /bcgov/cas-pipeline
  • /bcgov/cas-postgres
  • /bcgov/cas-shelf
  • /bcgov/cas-shipit
  • /bcgov/cas-shipit-engine

Files in this repository


Documentation

Contributors


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 2 days ago

Total Commits: 2,063
Total Committers: 16
Avg Commits per committer: 128.938
Development Distribution Score (DDS): 0.412

Commits in past year: 93
Committers in past year: 5
Avg Commits per committer in past year: 18.6
Development Distribution Score (DDS) in past year: 0.548

Name Email Commits
Dylan Leard d****n@b****s 1214
Matthieu Foucault m****u@b****s 350
Pierre Bastianelli p****i@g****a 201
Alec Wenzowski a****c@b****s 110
Josh Gamache j****e@g****m 49
Naomi Aro n****o@g****a 45
Hamza Javed h****a@b****s 32
Brianna Cerkiewicz b****a@b****s 26
Mike Vesprini m****e@b****s 14
dependabot-preview[bot] 2****] 10
dependabot[bot] 4****] 6
Patrick Isaac 4****c 2
SeSo s****r@g****m 1
Robert Dromey 1****y 1
Raj Persram r****m@g****a 1
Andrea Williams a****s@g****a 1

Committer domains:


Issue and Pull Request metadata

Last synced: 8 days ago

Total issues: 11
Total pull requests: 38
Average time to close issues: 17 days
Average time to close pull requests: 1 day
Total issue authors: 4
Total pull request authors: 7
Average comments per issue: 0.45
Average comments per pull request: 0.03
Merged pull request: 21
Bot issues: 1
Bot pull requests: 9

Past year issues: 2
Past year pull requests: 21
Past year average time to close issues: 16 days
Past year average time to close pull requests: 2 days
Past year issue authors: 1
Past year pull request authors: 5
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.0
Past year merged pull request: 15
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/bcgov/cas-ggircs

Top Issue Authors

  • pbastia (5)
  • joshgamache (3)
  • dleard (2)
  • dependabot[bot] (1)

Top Pull Request Authors

  • pbastia (11)
  • joshgamache (9)
  • dependabot[bot] (9)
  • dleard (6)
  • andrea-williams (1)
  • rdromey (1)
  • patrickisaac (1)

Top Issue Labels

  • User Story (2)
  • Tech Debt (2)
  • Good First Issue (1)
  • DevOps (1)
  • Bug (1)
  • dependencies (1)
  • submodules (1)
  • Task (1)
  • Backlog Refinement (1)

Top Pull Request Labels

  • dependencies (9)
  • python (4)
  • javascript (4)
  • submodules (1)
  • DevOps (1)

Dependencies

.github/workflows/immutable-sqitch-change.yml actions
  • actions/checkout v3 composite
.github/workflows/pre-release.yml actions
  • actions/checkout v2 composite
Dockerfile docker
  • perl 5.26 build
eccc/extract/Dockerfile docker
  • python 3.7-slim-buster build
eccc/file_server/Dockerfile docker
  • python 3.7-slim-buster build
eccc/upload/Dockerfile docker
  • node 14.17.5 build
ggircs-app/app/Dockerfile docker
  • debian 10 build
ggircs-app/schema/Dockerfile docker
  • perl 5.26 build
package.json npm
  • @release-it/conventional-changelog ^5.1.1 development
  • release-it ^15.5.1 development
yarn.lock npm
  • 482 dependencies
eccc/upload/app/package.json npm
  • @google-cloud/storage ^5.7.0
  • yargs ^15.3.1
eccc/upload/app/yarn.lock npm
  • 111 dependencies
ggircs-app/app/package.json npm
  • @babel/core ^7.12.13 development
  • @testing-library/cypress ^8.0.2 development
  • @testing-library/jest-dom ^5.16.1 development
  • @testing-library/react ^12.1.2 development
  • @testing-library/react-hooks ^7.0.2 development
  • @testing-library/user-event ^13.5.0 development
  • @types/enzyme ^3.10.8 development
  • @types/happo-cypress ^1.17.2 development
  • @types/jest ^26.0.0 development
  • @types/react ^16.14.0 development
  • @types/react-dom ^16.9.0 development
  • @types/react-relay ^13.0.0 development
  • @types/relay-runtime ^13.0.0 development
  • @types/relay-test-utils ^6.0.5 development
  • @typescript-eslint/eslint-plugin ^4.29.3 development
  • @typescript-eslint/parser ^4.29.3 development
  • @wojtekmaj/enzyme-adapter-react-17 ^0.6.5 development
  • babel-plugin-module-resolver ^4.1.0 development
  • babel-plugin-relay ^13.0.1 development
  • babel-plugin-styled-components ^1.13.3 development
  • cypress ^6.4.0 development
  • cypress-axe ^0.14.0 development
  • enzyme ^3.11.0 development
  • enzyme-to-json ^3.6.1 development
  • eslint ^7.2.0 development
  • eslint-config-airbnb ^18.2.1 development
  • eslint-config-airbnb-typescript ^14.0.1 development
  • eslint-config-next ^11.1.2 development
  • eslint-config-prettier ^8.3.0 development
  • eslint-plugin-cypress ^2.12.1 development
  • eslint-plugin-import ^2.25.2 development
  • eslint-plugin-jest ^25.2.1 development
  • eslint-plugin-jsx-a11y ^6.4.1 development
  • eslint-plugin-react ^7.26.1 development
  • eslint-plugin-react-hooks ^4 development
  • eslint-plugin-relay ^1.8.2 development
  • graphql-query-test-mock ^0.12.1 development
  • happo-cypress ^3.0.1 development
  • happo-e2e ^1.0.3 development
  • happo.io ^6.4.0 development
  • jest ^27.4.5 development
  • jest-canvas-mock ^2.3.0 development
  • jest-extended ^1.2.0 development
  • jest-mock ^27.4.2 development
  • jest-raw-loader ^1.0.1 development
  • nock ^13.0.7 development
  • prettier ^2.2.1 development
  • ts-node ^10.4.0 development
  • typescript ^4.4.4 development
  • wait-on ^5.2.1 development
  • @bcgov-cas/sso-react ^1.0.1
  • @button-inc/bcgov-theme ^1.0.1
  • @fortawesome/fontawesome-svg-core ^1.2.36
  • @fortawesome/free-solid-svg-icons ^5.15.4
  • @fortawesome/react-fontawesome ^0.1.15
  • @graphile-contrib/pg-many-to-many ^1.0.0
  • body-parser ^1.19.0
  • bootstrap-switch-button-react ^1.2.0
  • bowser ^2.11.0
  • connect-pg-simple ^6.2.1
  • consola ^2.15.3
  • cookie-parser ^1.4.5
  • cors ^2.8.5
  • delay ^5.0.0
  • dotenv ^8.2.0
  • dotenv-webpack ^7.1.0
  • express ^4.17.1
  • express-session ^1.17.1
  • graphile-build ^4.10.0
  • graphile-build-pg ^4.10.0
  • graphql ^15.4.0
  • identity-obj-proxy ^3.0.0
  • improved-yarn-audit ^3.0.0
  • isomorphic-fetch ^3.0.0
  • keycloak-connect ^12.0.1
  • lightship ^6.7.2
  • lodash.debounce ^4.0.8
  • morgan ^1.10.0
  • next 12.1.0
  • normalize.css ^8.0.1
  • path-to-regexp ^6.2.0
  • pg ^8.5.1
  • postgraphile ^4.12.3
  • postgraphile-log-consola ^1.0.1
  • postgraphile-plugin-connection-filter ^2.2.2
  • react ^17.0.2
  • react-bootstrap ^2.1.1
  • react-diff-view ^2.4.10
  • react-dom ^17.0.2
  • react-relay ^13.0.1
  • react-relay-network-modern ^6.2.1
  • react-toastify ^6.2.0
  • relay-compiler ^13.0.1
  • relay-nextjs ^0.4.1
  • relay-runtime ^13.0.1
  • relay-test-utils ^13.0.2
  • styled-components ^5.3.3
  • styled-jsx ^3.4.1
  • unidiff ^1.0.2
  • xml-formatter ^2.4.0
ggircs-app/app/yarn.lock npm
  • 1318 dependencies
eccc/extract/app/requirements.txt pypi
  • chardet ==3.0.4
  • psycopg2 ==2.8.5
  • smart_open ==5.2.1
eccc/file_server/requirements.txt pypi
  • Flask ==1.1.2
  • Jinja2 ==2.11.3
  • MarkupSafe ==1.1.1
  • Werkzeug ==1.0.1
  • attrs ==20.3.0
  • cachetools ==4.2.0
  • certifi ==2020.12.5
  • cffi ==1.14.4
  • chardet ==4.0.0
  • click ==7.1.2
  • google-api-core ==1.25.0
  • google-auth ==1.24.0
  • google-cloud-core ==1.5.0
  • google-cloud-storage ==1.35.0
  • google-crc32c ==1.1.2
  • google-resumable-media ==1.2.0
  • googleapis-common-protos ==1.52.0
  • gunicorn ==20.0.4
  • idna ==2.10
  • importlib-metadata ==3.4.0
  • iniconfig ==1.1.1
  • itsdangerous ==1.1.0
  • packaging ==20.8
  • pluggy ==0.13.1
  • protobuf ==3.15.0
  • py ==1.10.0
  • pyasn1 ==0.4.8
  • pyasn1-modules ==0.2.8
  • pycparser ==2.20
  • pyparsing ==2.4.7
  • pytest ==6.2.1
  • python-dotenv ==0.15.0
  • pytz ==2020.5
  • requests ==2.25.1
  • rsa ==4.7
  • six ==1.15.0
  • smart-open ==4.1.2
  • toml ==0.10.2
  • typing-extensions ==3.7.4.3
  • urllib3 ==1.26.5
  • zipp ==3.4.0
requirements.txt pypi
  • detect-secrets ==0.12.7
  • gitlint ==0.12.0
  • pre-commit ==1.18.3
.github/workflows/main.yaml actions
.github/actions/build-image/action.yaml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • docker/build-push-action v5 composite
  • docker/login-action v3 composite
  • docker/metadata-action v5 composite
  • docker/setup-buildx-action v3 composite
.github/workflows/build-images.yaml actions
  • ./.github/actions/build-image * composite
  • actions/checkout v4 composite

Score: 6.684611727667927