Skip to content

Installation & Setup

The installation of Shardian solvers is fully automated through a console-based interactive installer compatible with Linux, WSL (Windows Subsystem for Linux), and HPC clusters.

System Prerequisites

Before running the installer, ensure that the following commands are available on your system: * curl (required for package downloads). * singularity or apptainer (required if installing Shardian Atmos). * An active OpenFOAM environment (recommended versions: v2406, v2312, or v2412 if installing Shardian Aero).

1. Obtain your License Key

To download packages and run simulations, you need an active API Key (license key). * Evaluation and demo keys have the format: sk_live_shardian_cfd_atmos_2026_eval. * Production keys have the format: sk_live_shardian_aero_prod_XXXXXX or sk_live_shardian_atmos_prod_XXXXXX.

Save this key, as the installer will request it during setup.

2. Execute the Installer

Run the following command in your terminal to start the interactive installer:

curl -sL https://shardian.com/install.sh | bash

Installation Steps:

  1. License Verification: Enter your API key when prompted. The installer will securely validate the key against api.shardian.com/v1/verify over HTTPS.
  2. Product Selection:
    • Enter 1 to install Shardian Aero (libShardianAero.so).
    • Enter 2 to install Shardian Atmos (shardian_atmos.sif).
    • Enter 3 to install Both.
  3. Secure Download: The script downloads the corresponding pre-compiled binary and places it in your system:
    • Aero: Installed in /usr/local/lib/ (or ~/.shardian/lib/ if you lack root write privileges).
    • Atmos: Installed in /usr/local/bin/ (or ~/bin/), creating a global command wrapper shardian_atmos.
  4. Environment Configuration: The installer modifies your ~/.bashrc automatically to inject these environment variables: 
    export SHARDIAN_API_KEY="your_api_key_value"
export LD_LIBRARY_PATH="/usr/local/lib:$LD_LIBRARY_PATH"
export PATH="/usr/local/bin:$PATH"

3. Verify the Installation

After the installer finishes, restart your shell or run:

source ~/.bashrc

Verify that the environment variables are active:

echo $SHARDIAN_API_KEY
echo $LD_LIBRARY_PATH

You can manually test connectivity to the licensing server using curl:

curl -H "Authorization: Bearer $SHARDIAN_API_KEY" https://api.shardian.com/v1/verify

You should receive a successful verification response:

{"status":"valid","key":"sk_live_shar..."}