Installation:¶
GWForge is currently available only from source. Follow the steps below for the recommended installation for development or use.
1. Create Conda Environment:¶
conda create --name gwforge-venv python=3.9.18
This command sets up a Conda environment named gwforge-venv with Python 3.9.18 and basic packages. To activate the Conda environment, use:
conda activate gwforge-venv
2. Install Optional dependencies¶
It is recommended to install lalsuite, lalsimulation, etc. This can be done using:
conda install -c conda-forge fftw lalsimulation lalsimulation-data lalsuite lalframe lalapps gitpython jupyterlab wget framel
Adjust the installation based on your specific needs.
3. Finally install the package itself¶
Proceed to install gwforge and its dependencies:
pip install git+https://github.com/koustavchandra/gwforge.git
This installs gwforge along with necessary dependencies such as bilby, gwpy, pycbc gwpopulation, etc. Ensure you are using the correct pip version; check by running:
which pip
You should see output similar to:
~/.conda/envs/gwforge-venv/bin/pip
Installation on macOS and Windows¶
If you are installing gwforge
on macOS or Windows, you may encounter issues with the dependencies, particularly htcondor
, which is not available for these systems. In such cases, please follow the steps below:
Clone the repository:
git clone https://github.com/koustavchandra/gwforge.git cd gwforge
Install the package using the modified
requirements.txt
:pip install .
By customizing the installation process, you can ensure compatibility with your operating system.