souk 0.4.1
SO:UK Data Centre documentation.
License: BSD-3-Clause
Requires Python: >=3.9
Keywords: data centre, HPC, HTC, SO:UK

# SO:UK Data Centre

![GitHub Actions](https://github.com/simonsobs-uk/data-centre/workflows/Unit%20tests/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/souk-data-centre/badge/?version=latest)](https://docs.souk.ac.uk/en/latest/?badge=latest)
[![Documentation Status](https://github.com/simonsobs-uk/data-centre/workflows/GitHub%20Pages/badge.svg)](https://docs-ci.souk.ac.uk)

[![GitHub Releases](https://img.shields.io/github/tag/simonsobs-uk/data-centre.svg?label=github+release)](https://github.com/simonsobs-uk/data-centre/releases)
[![PyPI Package latest release](https://img.shields.io/pypi/v/souk.svg)](https://pypi.org/project/souk)
[![Supported versions](https://img.shields.io/pypi/pyversions/souk.svg)](https://pypi.org/project/souk)
[![Supported implementations](https://img.shields.io/pypi/implementation/souk.svg)](https://pypi.org/project/souk)
[![PyPI Wheel](https://img.shields.io/pypi/wheel/souk.svg)](https://pypi.org/project/souk)
[![Development Status](https://img.shields.io/pypi/status/souk.svg)](https://pypi.python.org/pypi/souk/)
[![Downloads](https://img.shields.io/pypi/dm/souk.svg)](https://pypi.python.org/pypi/souk/)
![License](https://img.shields.io/pypi/l/souk.svg)

This documents the baseline design of the SO:UK Data Centre at [Blackett](https://www.blackett.manchester.ac.uk).

The GitHub repository [simonsobs-uk/data-centre](https://github.com/simonsobs-uk/data-centre) contains

- [source of the documentation](https://github.com/simonsobs-uk/data-centre/tree/main/docs), including the codes in the documentation that you can run directly,
- the [Issues](https://github.com/simonsobs-uk/data-centre/issues) tracker as well as [Discussions](https://github.com/simonsobs-uk/data-centre/discussions), for any data centre related bugs or questions, and
- a Python package for data centre maintenance.

To access our documentation, you have a few options, (in the order from convenience to advanced usages):

1. [SO:UK Data Centre documentation at Read the Docs](https://docs.souk.ac.uk/en/latest/). This gives you access to all versions of SO:UK Data Centre documentations, as well as multiple output formats including [HTML](https://docs.souk.ac.uk/_/downloads/en/latest/htmlzip/), [ePub](https://docs.souk.ac.uk/_/downloads/en/latest/epub/), [PDF](https://docs.souk.ac.uk/_/downloads/en/latest/pdf/).
2. [SO:UK Data Centre documentation at GitHub Pages](https://docs-ci.souk.ac.uk/) which is HTML only and points to the latest commits only.
3. [SO:UK Data Centre documentation at GitHub Releases](https://github.com/simonsobs-uk/data-centre/releases/latest). This gives you additional output formats such as [man page](https://github.com/simonsobs-uk/data-centre/releases/latest/download/soukdatacentre.1) and [plain text](https://github.com/simonsobs-uk/data-centre/releases/latest/download/soukdatacentre.txt).

Note that [Read the Docs serves the searches from server-side powered by Elasticsearch](https://docs.readthedocs.io/en/stable/server-side-search/index.html). So searches from Read the Docs and GitHub Pages will gives you different results. Try the Read the Docs first for better results and fall back to GitHub Pages.

Lastly, those single file documentation formats are very suitable for feeding into Large Language Models (LLMs). For example, try downloading our [plain text](https://github.com/simonsobs-uk/data-centre/releases/latest/download/soukdatacentre.txt) format and upload it to [ChatGPT](https://chat.openai.com) or [Claude](https://claude.ai/chats) and start chatting. You can ask them to explain things in the documentations in details that we cannot covers here.