Installation

Prerequisites

Installation Steps

1. Download Required Files

Download these files manually by clicking on the following links and save them to any directory of your choice, e.g.: /path/to/your/downloads/:

File

Download Link

proper_v3.3.3_python.zip

Proper Library

roman_preflight_proper_public_v2.0.1_python.zip

Roman preflight Proper model

cgisim_v4.0.zip

CGISim

2. Clone required repositories

Navigate to a directory where you want to clone the repositories, then clone the CGI-EETC repo and this repo, CorgiSim-howfsc:

git clone https://github.com/nasa-jpl/cgi-eetc.git
git clone https://github.com/roman-corgi/corgihowfsc.git

3. Run Installation of corgihowfsc

Execute these commands in order:

# Navigate to your corgihowfsc repository clone
cd /path/to/corgihowfsc

# Step 1: Create conda environment and install git-based packages
conda env create -f environment.yml

# Step 2: Activate the environment
conda activate corgiloop

# Step 3: Install manual packages by providing the path to your downloads
python setup_cgi_packages.py /path/to/your/downloads/

# Examples:
python setup_cgi_packages.py ~/Downloads/
python setup_cgi_packages.py C:\Users\username\Downloads\
python setup_cgi_packages.py /home/user/cgi-files/

4. Get large files and install cgi-eetc

cd cgi-eetc
git lfs pull
pip install -e .

5. Verify Installation

Test that everything is installed correctly:

# In Python, try importing the packages
import proper
import roman_preflight_proper
import cgisim
import howfsc
import eetc

print("✅ All CGI packages imported successfully!")

Help

python setup_cgi_packages.py --help

Troubleshooting

Missing Downloads

  • Verify all 3 zip files are in your specified directory

  • Check file names match exactly (case-sensitive)

  • Use absolute paths to avoid confusion

Environment Issues

  • Ensure you activated the environment: conda activate corgiloop

  • Check conda environment exists: conda env list

Path Issues

  • Use absolute paths: /full/path/to/downloads/ instead of ~/Downloads/

  • On Windows, use forward slashes or escape backslashes: C:/Users/name/Downloads/

  • Check directory exists and contains the zip files

Installation Failures

  • Check internet connection for git repositories

  • Verify zip files are not corrupted

  • Try running setup_cgi_packages.py again

Valid FITS file error

If you encounter an error like this:

OSError: No SIMPLE card found, this file does not appear to be a valid FITS file. If this is really a FITS file, try with ignore_missing_simple=True

you are probably missing the LFS files from cgi-eetc.

To fix this…

  • Make sure you have Git LFS installed: https://git-lfs.github.com/

  • If you installed from a cgi-eetc repo clone, run git lfs pull in that directory to download the large files.