Welcome to AusCATverse, your starting point for all things AusCAT. This document is intended to point you towards relevant resource no matter your role within AusCAT.
You can access more "Getting Started" and technical information for AusCAT here.
A description of projects underway within AusCAT can be found on our SharePoint:
For information of typical server hardware requirements as well as Virtual Machine (VM) setup see our infrastructure guide.
Please follow the Simulation Environment guide to get setup with a sandbox environment for an ausCAT node, followed by the Production deployment guide to setup a production grade environment.
To deploy and run the various components of AusCAT, code and tools are tracked across a number of GitHub repositories found within the ACDN organisation:
- auscatverse: This repository. Used to collect documentation and guides for getting started with AusCAT.
- auscat_installation: Collects code, tools and documentation for the installation of the AusCAT platform.
- auscat_imaging: Provides functionality and documentation for working with medical images within AusCAT.
- auscat_etl: Provides general tools, scripts and documentation for the Extracting, Transforming and Loading of data.
- auscat_etl_centres: Provides Extracting, Transforming and Loading of scripts which are specific to one or more AusCAT centres.
- auscat_ontology: Contains tools and documentation for dealing with the ontologies used within AusCAT.
- auscat_federated_learning: The federated learning functionality is contained within this repository along with documentation and guidance on its usage.
The following repositories contain code to running a specific project(s) within AusCAT:
- auscat_cardiac: Contains code to run our cardiac substructure auto-segmentation tool and to extract and analyse the structure similarity and dosimetric metrics.
Any and all contributions to our code repositories are appreciated. Please be sure to follow our AusCAT coding guidelines as these help us ensure a high quality standard consistently across our repositories.
If you run into any difficulties at any step along the way, please join our discussion forum. Here you can post any questions you have or browse previous discussion and posts for issues (and their resolution) typically come across in AusCAT.
If you have found some specific bug/issue please report this as a GitHub issue directly, attaching it to the most relevant repository (of those listed above).
Please don't hesitate to reach out to your centre's AusCAT contact. If you're unsure who this is please contact Lois Holloway directly.
The AusCAT documentation will build from this repository using a GitHub action. To build the documentation locally you can run the following command from the root folder of the repository:
sphinx-build -b html -a docs docs/site