Administrator Guide

Note

This guide is intended for members of the Core SKIRT Team who are responsible for managing the SKIRT project and its online presence. It is of no interest to other users.

The topics in the administrator guide are organized in three chapters: background information, setting up, and regular operation.

Background information

To become an administrator you should be an experienced SKIRT user and an at least occasional SKIRT developer, so that you already have a working knowledge of many of the relevant subjects. In any case, the following topics provided by other areas of this web site are of special interest to an administrator. You should carefully review them before proceeding.

• Contributing - describes the key elements of the SKIRT project's online presence
• Components of the SKIRT project
• Overall structure of the SKIRT code
• Overall structure of the PTS code
• Design principles and coding style
• PTS coding style
• The GitHub workflow for the SKIRT project
• Generating the SKIRT project documentation

Setting up

As an administrator you need write access to the relevant servers, and you need a very complete SKIRT project and tooling installation on your computer. This section provides guidance on how to accomplish this setup.

• Write access to the SKIRT project's online presence
• Software tools for the administrator
• SKIRT project directory structure

Regular operation

These topics provide guidance for performing the "daily" administrative operations for the SKIRT project.

• Managing the GitHub presence
• Managing functional tests
• Managing benchmarks
• Creating resources and resource packs
• Providing automated ski file upgrades
• Supporting multiple platforms
• Updating SKIRT
• Updating PTS
• Maintaining the publications gallery
• Updating the web site
• Making backups