Installation

Installation#

  1. Create a virtual environment (optional but recommended):

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

  1. Clone the Sci-Eng-Interface repository. This repository contains all the relevant and updated telescope and detector parameters.

git clone https://github.com/HWO-GOMAP-Working-Groups/Sci-Eng-Interface/tree/main

Warning

This will be deprecated in v.2.0.

  1. (Optional) Create a folder containing the “Yield Input Packages”. More information on the Coronagraph (YIP) Guide.

  2. Install pyEDITH via command line:

pip install pyedith

Alternatively, you can clone the pyEDITH repository and install it:

git clone https://github.com/HWO-Project/pyEDITH.git
cd pyEDITH
pip install -e .

  1. Set up environment variables: Add the following lines to your .bashrc or .zshrc file:

export SCI_ENG_DIR="/path/to/Sci-Eng-Interface/hwo_sci_eng"

And, if you created the YIP folder,

export YIP_CORO_DIR="/path/to/yip/folder"

Replace the paths with the actual paths on your system.