SATRE Specification Repository

View the SATRE Specification on Read the Docs

This repository contains the source files for the SATRE (Standard Architecture for Trusted Research Environments) specification documentation, built with Sphinx and hosted on Read the Docs.

About SATRE

SATRE is the UK's first open, community-led specification for Trusted Research Environments (TREs). Developed through extensive collaboration with over 60 organisations and informed by public engagement, SATRE provides a comprehensive framework for building, operating, and evaluating TREs across academia, healthcare, industry, and government.

Contributing

We welcome contributions from the community! There are several ways to get involved:

Report an Issue

The easiest way to contribute is to log an issue on GitHub. Your issue will be:

• Reviewed by the SATRE team
• Shared with the community for discussion
• Addressed in future updates to the specification

Contact the Team

You can also reach out directly to any of our technical contacts with questions, suggestions, or proposals.

Other Ways to Contribute

Join the UKTRE Community

• Slack workspace
• Mailing List

Key Features

Dynamic Specification Tables

The specification is generated from docs/source/spec/specification.yaml using a custom Sphinx extension (yamlspec.py). The specification is organized into four pillars:

• Information Governance
• Computing Technology and Information Security
• Data Management
• Supporting Capabilities
• Federation (extension for federated TREs)

Building the Documentation Locally

Prerequisites

• Python 3.11+
• pip

Installation

1. Clone the repository:

git clone https://github.com/sa-tre/satre-specification.git
cd satre-specification

2. Install dependencies:

cd docs
pip install -r requirements.txt

3. Build the documentation:

make html

4. View the built documentation:

# Open docs/build/html/index.html in your browser

Updating the Specification

To update the specification content:

1. Edit the YAML specification file: docs/source/spec/specification.yaml
2. Rebuild the documentation

Code of Conduct

The SATRE project is committed to fostering an inclusive, equitable, and respectful environment for all participants. Please review our Code of Conduct.

License

The content of this repository is licensed under the Creative Commons Attribution 4.0 International Public License.

Technical Contacts

For technical questions about this repository:

• Tim Machin - @machintim
• Simon Li - @manics
• Chris Cole - @drchriscole
• Rob Baxter - @rmbaxter67

Acknowledgements

Version 1 of SATRE was supported by UKRI via the DARE UK Phase 1 driver projects programme. Version 2 was created as part of the DARE UK TREvolution programme.