Installation Guide

GWeasy requires Windows Subsystem for Linux (WSL) to support OMICRON pipelines and gravitational wave analysis libraries. Follow the steps below to configure WSL and select an installation method.

Mandatory WSL Setup

All Windows installation methods for GWeasy require WSL to run OMICRON and associated dependencies.

Step-by-Step WSL Configuration

  1. Enable WSL: Open "Turn Windows features on or off," select "Windows Subsystem for Linux," and restart your computer. Refer to Microsoft’s WSL setup guide for details.
  2. Select WSL Environment: Choose the pre-configured Ubuntu-based WSL image (recommended, see Pre-Configured WSL) or configure a custom WSL distribution (see Custom WSL Setup if you have an existing WSL installation or prefer manual configuration). Multiple WSL distributions are supported.
  3. Install WSL2: Open PowerShell as Administrator and run: wsl --install. This installs WSL2 and a default distribution if not using the pre-configured image.
  4. Retrieve WSL Username: Launch WSL with wsl, then run whoami to obtain your username for OMICRON configuration.

Windows Installation Options

After configuring WSL, select one of the following methods to install GWeasy.

Pre-Configured WSL (Recommended)

  1. Download WSL Image: Obtain the pre-configured Ubuntu-based GWeasy WSL image: Download GWeasywsl.tar.
  2. Download Conda Environment: Obtain the preconfigured Conda environment: Download GWeasy_conda_env.tar.gz.
  3. Import Conda Environment: Extract the Conda environment with tar -xzf GWeasy_conda_env.tar.gz and import it using conda env create -f GWeasy_conda_env.yml in the WSL terminal.
  4. Download Batch File: Acquire the WSL import script: Download installwsl.bat
  5. Execute Batch File: Double-click installwsl.bat and specify an installation path (default: C:\Users\%USERNAME%\GWeasywsl).
  6. Launch GWeasy: Run wsl -d GWeasyWSL ./GWeasy in PowerShell.
  7. Retrieve WSL Username: In WSL, run wsl -d GWeasyWSL, then whoami to obtain your username for OMICRON configuration.
Custom WSL Setup

For users with an existing WSL installation or those preferring manual configuration, install dependencies as outlined in WSLREADME.md. Clone the repository: git clone https://github.com/shantanu-parmar/GWeasy.git. Multiple WSL distributions are supported.

Standalone EXE

  1. Verify WSL Configuration: Complete the Mandatory WSL Setup to enable the required environment.
  2. Download Download GWeasy.exe.
  3. Double Click on the exe and you are ready to explore the depths of the cosmos!

Zip-Based Run

  1. Verify WSL Configuration: Complete the Mandatory WSL Setup to enable the required environment.
  2. Download Zip: Obtain the precompiled GWeasy zip: Download GWeasy.zip.
  3. Extract and Run: Extract the zip file and double-click GWeasy.exe to launch GWeasy.

Python Installation via pip

pip install gweasy

Linux Installation

GWeasy on Linux offers seamless integration through the following methods.

Snapcraft Image (Coming Soon)

Install via Snapcraft for easy distribution and updates.

Executable via chmod

Download the binary and run with chmod +x GWeasy && ./GWeasy: Download GWeasy.

macOS Installation (Coming Soon)

GWeasy on macOS offers seamless integration through the following methods.

Snapcraft Image (Coming Soon)

Run executable

Web/Server Mounted (Coming Soon)

Run GWeasy on a server or access via web browser for collaborative analysis. More details coming soon.