assuranceplatform

Project to facilitate creation of Assurance Cases

https://github.com/alan-turing-institute/assuranceplatform

Science Score: 85.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 19 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    5 of 14 committers (35.7%) from academic institutions
  • Institutional organization owner
    Organization alan-turing-institute has institutional domain (turing.ac.uk)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.7%) to scientific vocabulary

Keywords

ai-governance hut23 hut23-958

Keywords from Contributors

battery uncertainty-quantification mcmc gaussian-processes active-learning ensemble history-matching hut23-1468 emulation sensitivity-analysis
Last synced: 6 months ago · JSON representation ·

Repository

Project to facilitate creation of Assurance Cases

Basic Info
  • Host: GitHub
  • Owner: alan-turing-institute
  • License: mit
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 126 MB
Statistics
  • Stars: 29
  • Watchers: 6
  • Forks: 8
  • Open Issues: 41
  • Releases: 1
Topics
ai-governance hut23 hut23-958
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

Trustworthy and Ethical Assurance Platform

An illustration representing the collaborative development of a structured assurance case. The image shows various groups of people working together across different workstations linked by different paths.

Go to the TEA Platform DOI Backend Coverage Frontend Coverage License: MIT

Development Quickstart 💻

Get the TEA Platform running locally with Docker in just a few steps:

Prerequisites

Quick Setup

  1. Clone the repository

bash git clone https://github.com/alan-turing-institute/AssurancePlatform.git cd AssurancePlatform

  1. Set up environment files

bash # Copy example environment files cp tea_backend/.env.example tea_backend/.env.local cp tea_frontend/.env.example tea_frontend/.env.local

  1. Configure GitHub OAuth (optional)
  • Create a new GitHub OAuth App
  • Set Homepage URL: http://localhost:3000
  • Set Authorization callback URL: http://localhost:3000/api/auth/callback/github
  • Add your Client ID and Client Secret to both .env.local files
  1. Start the development environment

bash docker-compose -f docker-compose.development.yml up --build

  1. Access the platform
    • 🌐 Frontend: http://localhost:3000
    • 🔧 Backend API: http://localhost:8000/api
    • 🗄️ Database: PostgreSQL on localhost:5432

The platform includes user registration, so you can create an account directly or sign in with GitHub (optional). For more detailed setup instructions, see the technical documentation.

About this Repository 🗂

This repository contains the code and documentation for the Trustworthy and Ethical Assurance (TEA) platform—an application for building trustworthy and ethical assurance cases, developed by researchers at the Alan Turing Institute and University of York.

What is TEA? 🫖

The Trustworthy and Ethical Assurance (TEA) Platform is a collaborative tool for developing structured arguments about how ethical principles and trustworthy practices have been upheld throughout the lifecycle of data-driven technologies.

At its core, TEA helps multi-stakeholder project teams create assurance cases: structured, graphical representations that demonstrate how goals like fairness, explainability, safety, or sustainability have been achieved over the course of a project's lifecycle.

The platform addresses a fundamental challenge in responsible technology development: how can project teams provide justified evidence that ethical principles have been upheld?

TEA supports this through three integrated components:

  1. An interactive tool for building assurance cases
  2. A comprehensive framework of skills and capabilities resources
  3. A collaborative community infrastructure that promotes open practices and shared learning in the trustworthy assurance ecosystem

Documentation 📄

Our documentation site can be accessed at https://assuranceplatform.azurewebsites.net/documentation

Further Resources 📚

The following resources provide additional information about the Trustworthy and Ethical Assurance framework and methodology:

  • Burr, C., Arana, S., Gould Van Praag, C., Habli, I., Kaas, M., Katell, M., Laher, S., Leslie, D., Niederer, S., Ozturk, B., Polo, N., Porter, Z., Ryan, P., Sharan, M., Solis Lemus, J. A., Strocchi, M., Westerling, K., (2024) Trustworthy and Ethical Assurance of Digital Health and Healthcare. https://doi.org/10.5281/zenodo.10532573
  • Porter, Z., Habli, I., McDermid, J. et al. A principles-based ethics assurance argument pattern for AI and autonomous systems. AI Ethics 4, 593–616 (2024). https://doi.org/10.1007/s43681-023-00297-2
  • Burr, C. and Powell, R., (2022) Trustworthy Assurance of Digital Mental Healthcare. The Alan Turing Institute https://doi.org/10.5281/zenodo.7107200
  • Burr, C., & Leslie, D. (2022). Ethical assurance: A practical approach to the responsible design, development, and deployment of data-driven technologies. AI and Ethics. https://doi.org/10.1007/s43681-022-00178-0

Funding Statements 💷

From March 2024 until September 2024, the project is funded by UKRI's BRAID programme as part of a scoping research award for the Trustworthy and Ethical Assurance of Digital Twins project.

Between April 2023 and December 2023, this project received funding from the Assuring Autonomy International Programme, a partnership between Lloyd’s Register Foundation and the University of York, which was awarded to Dr Christopher Burr.

Between July 2021 and June 2022 this project received funding from the UKRI’s Trustworthy Autonomous Hub, which was awarded to Dr Christopher Burr (Grant number: TASPP00040).

Owner

  • Name: The Alan Turing Institute
  • Login: alan-turing-institute
  • Kind: organization
  • Email: info@turing.ac.uk

The UK's national institute for data science and artificial intelligence.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Assurance Platform
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Flora
    family-names: Roumpani
    affiliation: The Alan Turing Institute
  - given-names: Nick
    family-names: Barlow
    affiliation: The Alan Turing Institute
  - given-names: Markus
    family-names: Hauru
    affiliation: The Alan Turing Institute
  - given-names: Aoife
    family-names: Hughes
    email: ahughes@turing.ac.uk
    affiliation: The Alan Turing Institute
    orcid: "http://orcid.org/0000-0002-4572-5828"
  - given-names: Kalle
    family-names: Westerling
    affiliation: The Alan Turing Institute
    orcid: "http://orcid.org/0000-0002-2014-332X"
  - given-names: Cassandra
    family-names: Gould van Praag
    affiliation: The Alan Turing Institute
  - given-names: Christopher
    family-names: Burr
    affiliation: The Alan Turing Institute
    orcid: "https://orcid.org/0000-0003-0386-8182"
identifiers:
  - type: doi
    value: 10.5281/zenodo.8198986
    description: Zenodo Release
  - type: url
    value: >-
      https://github.com/alan-turing-institute/AssurancePlatform
    description: GitHub page
url: 'https://github.com/alan-turing-institute/AssurancePlatform'
version: 1.0.0
date-released: '2022-09-23'

GitHub Events

Total
  • Issues event: 75
  • Watch event: 5
  • Delete event: 64
  • Issue comment event: 173
  • Push event: 246
  • Pull request review event: 10
  • Pull request event: 59
  • Fork event: 3
  • Create event: 25
Last Year
  • Issues event: 75
  • Watch event: 5
  • Delete event: 64
  • Issue comment event: 173
  • Push event: 246
  • Pull request review event: 10
  • Pull request event: 59
  • Fork event: 3
  • Create event: 25

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 827
  • Total Committers: 14
  • Avg Commits per committer: 59.071
  • Development Distribution Score (DDS): 0.699
Past Year
  • Commits: 449
  • Committers: 11
  • Avg Commits per committer: 40.818
  • Development Distribution Score (DDS): 0.445
Top Committers
Name Email Commits
AoifeHughes a****s@t****k 249
nbarlowATI n****w@t****k 226
Markus Hauru m****u@t****k 106
Christopher Burr c****r@g****m 56
pre-commit-ci[bot] 6****] 48
William Frankish w****h@o****k 40
Flora Roumpani f****i@t****k 23
allcontributors[bot] 4****] 22
Flora f****1@u****k 21
Ed Chapman - Turing e****c@g****m 16
Kalle Westerling k****g@b****k 16
Kalle Westerling 7****g 2
Aoife Hughes a****e@A****l 1
Sophie Arana a****e@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 202
  • Total pull requests: 195
  • Average time to close issues: 5 months
  • Average time to close pull requests: 4 days
  • Total issue authors: 14
  • Total pull request authors: 13
  • Average comments per issue: 2.72
  • Average comments per pull request: 0.99
  • Merged pull requests: 177
  • Bot issues: 0
  • Bot pull requests: 26
Past Year
  • Issues: 39
  • Pull requests: 58
  • Average time to close issues: 5 months
  • Average time to close pull requests: 7 days
  • Issue authors: 5
  • Pull request authors: 5
  • Average comments per issue: 1.82
  • Average comments per pull request: 0.67
  • Merged pull requests: 46
  • Bot issues: 0
  • Bot pull requests: 2
Top Authors
Issue Authors
  • chrisdburr (87)
  • kallewesterling (79)
  • AoifeHughes (48)
  • cptanalatriste (14)
  • RichGriff (12)
  • aranas (10)
  • WFrankishOCC (10)
  • nbarlowATI (10)
  • mhauru (5)
  • JimCircadian (1)
  • dpshelio (1)
  • entopia (1)
  • cassgvp (1)
  • marlonscloud (1)
  • edchapman88 (1)
Pull Request Authors
  • cptanalatriste (71)
  • RichGriff (67)
  • AoifeHughes (41)
  • chrisdburr (32)
  • nbarlowATI (28)
  • pre-commit-ci[bot] (25)
  • kallewesterling (23)
  • mhauru (12)
  • edchapman88 (10)
  • allcontributors[bot] (7)
  • WFrankishOCC (5)
  • ethanknights (1)
  • aranas (1)
  • dpshelio (1)
Top Labels
Issue Labels
enhancement (59) bug (43) documentation (22) S1-improved-navigation (13) planning (9) question (8) good first issue (8) design (6) workshop-2024 (6) help wanted (4) collaboration-features (4) S2-github-google-integration (3) task (2) system-c (2) occ (2) improved navigation (1) customisation (1) blocked! (1) infrastructure (1) skills-training (1) S8-documentation (1) invalid (1)
Pull Request Labels
documentation (21) enhancement (9) bug (6) design (1)

Dependencies

frontend/package-lock.json npm
  • 1962 dependencies
frontend/package.json npm
  • @testing-library/jest-dom ^5.15.0
  • @testing-library/react ^11.2.7
  • @testing-library/user-event ^12.8.3
  • babel-plugin-dynamic-import-node ^2.3.3
  • babel-plugin-transform-require-context ^0.1.1
  • file-saver ^2.0.5
  • grommet ^2.20.1
  • grommet-icons ^4.7.0
  • jest-fetch-mock ^3.0.3
  • jest-transform-stub ^2.0.0
  • mermaid ^8.13.10
  • pattern.css ^1.0.0
  • prettier ^2.5.1
  • react ^17.0.2
  • react-dom ^17.0.2
  • react-mermaid2 ^0.1.4
  • react-router-dom ^6.2.1
  • react-scripts 4.0.3
  • react-zoom-pan-pinch ^2.1.3
  • regenerator-runtime ^0.13.9
  • styled-components ^5.3.3
  • uuid ^8.3.2
  • web-vitals ^1.1.2
eap_backend/requirements.txt pypi
  • Django ==3.2.8
  • asgiref ==3.4.1
  • black ==21.10b0
  • certifi ==2021.10.8
  • click ==8.0.3
  • colorama ==0.4.4
  • coverage ==6.3.2
  • django-allauth ==0.50.0
  • django-cors-headers ==3.10.0
  • django-extensions ==3.1.3
  • django-rest-auth ==0.9.5
  • django-test ==0.4030
  • django-urls ==1.1.3
  • djangorestframework ==3.12.4
  • mypy-extensions ==0.4.3
  • pathspec ==0.9.0
  • platformdirs ==2.4.0
  • pre-commit ==2.17.0
  • psycopg2-binary ==2.9.3
  • pytz ==2021.3
  • regex ==2021.10.23
  • sqlparse ==0.4.2
  • tomli ==1.2.2
  • typing-extensions ==3.10.0.2
  • wincertstore ==0.2
.github/workflows/backend-docker.yaml actions
  • actions/checkout v3 composite
  • docker/login-action v1 composite
.github/workflows/backend-tests.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • coverallsapp/github-action master composite
.github/workflows/ci.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/frontend-docker.yaml actions
  • actions/checkout v3 composite
  • docker/login-action v1 composite
.github/workflows/frontend-tests.yaml actions
  • actions/checkout v2 composite
  • actions/setup-node v1 composite
docker-compose.yml docker
  • turingassuranceplatform/eap_backend main
  • turingassuranceplatform/eap_frontend main
eap_backend/Dockerfile docker
  • nikolaik/python-nodejs latest build
frontend/Dockerfile docker
  • node 20.3.1 build
pyproject.toml pypi
site/requirements.txt pypi
  • CairoSVG >=2.5.2
  • mkdocs-glightbox >=0.2.0
  • mkdocs-material >=9.1.14
  • pillow >=9.2.0