Installation
Configuration files
Clone the repository https://github.com/tardis-sn/connector25 to your preferred location.
Data files
Download from our Zenodo repository at XXXXXXXXXXXXXXXXXX
MESA
MESA is a versatile open-source 1D stellar evolution code. For the Connector 25 project, we install MESA version 24.08.1 and MESA SDK version 24.7.1/24.10.1/25.3.1 (Linux (Intel/AMD) / Mac OS (Intel) / Mac OS (ARM)) for bit-for-bit reproducibility.
MESA container
MESA is also provided through a pre-built container.
It can be obtained from DockerHub using the command:
docker pull CONNECTORUSERNAME/mesa-connector:XXXXXX
Run with Docker
To run the built container with Docker to check it has built correctly,
run sudo docker run -it mesa-latest. This will drop you into a bash prompt.
MESA is located in /mesa-24.08.1 and the SDK in /opt/mesadsk.
Run exit to end the container.
To use the container to run the MESA step of the Connector with Docker, you will
need to bind your copy of the Connector repository to the container. Run the
command sudo docker run -v /path/to/connector25:/connector25-it mesa-latest.
Now the path /connector25 within the container prompt will have access to your
local copy of the Connector repository.
Run with Singularity/Apptainer
To run the built container on an HPCC you will likely need to use (Singularity)[https://docs.sylabs.io/guides/3.5/user-guide/introduction.html] or (Apptainer)[https://apptainer.org/docs/user/latest/] (these are basically the same thing as of March 2025).
Pull the container from DockerHub using the command
singularity pull singularity pull docker://CONNECTORUSERNAME/mesa-connector:24.08.1.
Run the container using singularity run mesa-connector_24.08.1.sif. Singularity
automatically mounts your home directory, so you can navigate to your clone of
the Connector repository within the container prompt.
Build
This is not needed for users of the pipeline.
We also provide a Docker definitions file to allow the production of a
containerized version of MESA using the versions described above.
To build the container, install Docker.
Then download the zip for MESA version 24.08.1
and run the command sudo docker build -f /path/to/mesa.dockerfile -t mesa-latest .
in the same directory as mesa-24.08.1.zip.
STELLA container
Run with Docker
STELLA is part of the MESA container.
SNEC container
Build
We provide a Docker definitions file to allow the production of a
containerized version of SNEC
using version 1.01. To build the container, install Docker
and run the command sudo docker build -f /path/to/snec.dockerfile -t snec ..
Run with Docker
To run the built container with Docker to check it has built correctly,
run sudo docker run -it snec. This will drop you into a bash prompt in the
SNEC directory. Run exit to end the container.
To use the container to run the SNEC step of the Connector with Docker, you will
need to bind your copy of the Connector repository to the container. Run the
command sudo docker run -v /path/to/connector25:/connector25-it snec.
Run with Singularity/Apptainer
To run the built container on an HPCC you will likely need to use (Singularity)[https://docs.sylabs.io/guides/3.5/user-guide/introduction.html] or (Apptainer)[https://apptainer.org/docs/user/latest/] (these are basically the same thing as of March 2025).
Pull the container from DockerHub using the command
singularity pull docker://CONNECTORUSERNAME/snec:XXXXXX.
Run the container using singularity run snec-XXXXXX. Singularity
automatically mounts your home directory, so you can navigate to your clone of
the Connector repository within the container prompt.
STIR
STIR is only provided using our pre-built container.
Run with Docker
Pull the container from DockerHub using the command
docker pull CONNECTORUSERNAME/stir-connector:XXXXXXX.
To use the container to run the STIR step of the Connector with Docker, you will
need to bind your copy of the Connector repository to the container. Run the
command sudo docker run -v /path/to/connector25:/connector25-it stir-latest.
Now the path /connector25 within the container prompt will have access to your
local copy of the Connector repository.
Run with Singularity/Apptainer
To run the built container on an HPCC you will likely need to use (Singularity)[https://docs.sylabs.io/guides/3.5/user-guide/introduction.html] or (Apptainer)[https://apptainer.org/docs/user/latest/] (these are basically the same thing as of March 2025).
Pull the container from DockerHub using the command
singularity pull docker://CONNECTORUSERNAME/stir-connector:XXXXXX.
Run the container using singularity run stir-connector-XXXXXX. Singularity
automatically mounts your home directory, so you can navigate to your clone of
the Connector repository within the container prompt.
TARDIS
Standard installation of TARDIS can be accomplished using our locked environment file, with instructions here. The release of TARDIS used as part of the Connector is XXXX.
TARDIS container
Build
We also provide a Docker definitions file to allow the production of a
containerized version of TARDIS using the version described above.
To build the container, install Docker
and run the command sudo docker build -f /path/to/tardis.dockerfile -t tardis ..
Run with Docker
To run the built container with Docker to check it has built correctly,
run sudo docker run -it tardis. This will drop you into a bash prompt.
TARDIS is located in /tardis-release-XXXX. Run exit to end the container.
To use the container to run the TARDIS step of the Connector with Docker, you will
need to bind your copy of the Connector repository to the container. Run the
command sudo docker run -v /path/to/connector25:/connector25-it tardis.
Run with Singularity/Apptainer
To run the built container on an HPCC you will likely need to use (Singularity)[https://docs.sylabs.io/guides/3.5/user-guide/introduction.html] or (Apptainer)[https://apptainer.org/docs/user/latest/] (these are basically the same thing as of March 2025).
Pull the container from DockerHub using the command
singularity pull docker://CONNECTORUSERNAME/tardis-connector:XXXXXX.
Run the container using singularity run tardis-connector-XXXXXX. Singularity
automatically mounts your home directory, so you can navigate to your clone of
the Connector repository within the container prompt.