Quickstart

This section explains how to run the Ising-TExS Equation of State (EoS) module with minimal setup.

To use the latest available release, replace <TAG> in the commands below with the version listed on the CE modules registry page.

On the Calculation Engine (CE)

The module can be run directly on the MUSES CE.

For instructions on submitting jobs and retrieving outputs, see the MUSES Quick Start Guide.

Key module information for CE runs:

Module name: eos_ising_texs_2d

Locally

You can run the module locally in two ways:

using Docker (recommended), or
building and running it directly on your machine.

Using Docker

Running the module with Docker is the fastest and most reliable way to get started locally. First, make sure that Docker is installed on your system.

You can run the module using either:

a pre-built image (recommended), or
local Docker scripts (recommended for development).

1. Using a pre-built image

Pull the Docker image from the GitLab Container Registry:

docker pull registry.gitlab.com/nsf-muses/module-ising-eos/ising_eos:<TAG>

Prepare your project directory:

project/
├── input/
│   └── config.yaml
└── output/

Run the container:

export DOCKER_IMAGE_NAME=registry.gitlab.com/nsf-muses/module-ising-eos/ising_eos
export DOCKER_IMAGE_TAG=<TAG>

docker run -it --rm --name Ising-TExS \
   -v "${PWD}/input:/opt/input" \
   -v "${PWD}/output:/opt/output" \
   ${DOCKER_IMAGE_NAME}:${DOCKER_IMAGE_TAG} \
   python src/main.py input/config.yaml

After the run completes, the processed CSV outputs will appear in the output/ directory:

Thermo_*.csv: thermodynamic quantities on the \((T,\mu_B)\) grid
transition_line.csv: transition line data \((\mu_B, T_c(\mu_B))\)

2. Using local Docker scripts

If you are working on or modifying the codebase, you can use the provided helper scripts.

First, build the Docker image locally:

bash build_docker.sh

Then run the module:

bash run_docker.sh

These scripts: - build and run the container, - mount the input/ and output/ directories, - execute the module automatically.

After the run completes, the processed CSV outputs will be available in the output/ directory:

Thermo_*.csv
transition_line.csv

Without Docker

To run the module without Docker, clone the Ising-TExS EoS repository to your local machine and install the required dependencies listed in requirements.txt.

Start by downloading the repository:

git clone --depth 1 --branch <TAG> https://gitlab.com/nsf-muses/module-ising-eos/ising_eos.git

1. Install the required packages

Ensure that your system has:

an up-to-date version of the GCC compiler
Python 3

Main Python dependencies include:

We recommend using a Python virtual environment:

python3 -m venv .venv
source .venv/bin/activate

Install dependencies:

pip install -r requirements.txt

2. Compile and build

Compile the C++ backend:

make

This creates the executable Ising_TExS_EoS.

3. Run the module

From the root directory of the repository (where src/, input/, and output/ are located), run:

python3 src/main.py input/config.yaml

After the run completes, the processed CSV outputs will appear in the output/ directory:

Thermo_*.csv
transition_line.csv