Skip to content

v1.7.0 - Locked parameters and vectorization #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eleonoraalei merged 7 commits into from
Jul 13, 2026
Merged

v1.7.0 - Locked parameters and vectorization #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3d31e7b
Bugfix. Set nchannels=1. Regrid some values that were not regridded p…
eleonoraalei Jul 6, 2026
cece501
Locked some default parameters in EAC/YIP mode. Updated README/glossa…
eleonoraalei Jul 9, 2026
fbb4166
Verified tutorials (removed trade space tutorial, to be made a separa…
eleonoraalei Jul 9, 2026
fafc571
Added option to override locked parameters (advanced). Unit tested.
eleonoraalei Jul 10, 2026
06ac6b3
Bump to 1.7.0 in pyproject.toml. Changed repository address.
eleonoraalei Jul 10, 2026
d9d29a8
Added DeprecationWarning for npix_multiplier and fix for that. Heads-…
eleonoraalei Jul 10, 2026
a9cbfb0
Restored behavior of QE treatment (a bug was introduced in the previo…
eleonoraalei Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
</p>

<p align="center">
<a href="https://app.codecov.io/gh/HWO-Project/pyEDITH">
<img src="https://img.shields.io/codecov/c/github/HWO-Project/pyEDITH?style=for-the-badge&logo=codecov" alt="Codecov">
<a href="https://app.codecov.io/gh/HabitableWorldsObservatory/pyEDITH">
<img src="https://img.shields.io/codecov/c/github/HabitableWorldsObservatory/pyEDITH?style=for-the-badge&logo=codecov" alt="Codecov">
</a>
<a href="https://pyedith.readthedocs.io/en/latest/">
<img src="https://readthedocs.org/projects/pyedith/badge/?version=latest&style=for-the-badge" alt="Documentation Status">
</a>
<a href="https://github.com/HWO-Project/pyEDITH/actions/workflows/run_and_test.yml/">
<img src="https://img.shields.io/github/actions/workflow/status/HWO-Project/pyEDITH/run_and_test.yml?branch=main&logo=github&style=for-the-badge" alt="CI">
<a href="https://github.com/HabitableWorldsObservatory/pyEDITH/actions/workflows/run_and_test.yml/">
<img src="https://img.shields.io/github/actions/workflow/status/HabitableWorldsObservatory/pyEDITH/run_and_test.yml?branch=main&logo=github&style=for-the-badge" alt="CI">
</a>
<a href="https://zenodo.org/records/17917471"><img src="https://img.shields.io/badge/DOI-doi.org%2Fzenodo.17917471-blue?style=for-the-badge" alt="DOI"></a>
</p>
Expand Down Expand Up @@ -38,7 +38,7 @@ pip install pyEDITH
Or, if preferred, clone the pyEDITH repository and install locally:

```
git clone https://github.com/HWO-Project/pyEDITH.git
git clone https://github.com/HabitableWorldsObservatory/pyEDITH.git
cd pyEDITH
pip install -e .
```
Expand Down Expand Up @@ -105,8 +105,6 @@ This mode offers much more flexibility to run the ETC. We refer to our tutorials
| npsfratios | Integer | Scalar | Number of PSF ratios | |
| nrolls | Integer | Scalar | Number of roll angles | |
| nchannels | Integer | Scalar | Number of channels | |
| minimum_IWA | λ/D | Scalar | Minimum Inner Working Angle | |
| maximum_OWA | λ/D | Scalar | Maximum Outer Working Angle | |
| coronagraph_optical_throughput | Dimensionless | [nlambda] | Throughput for all coronagraph optics | |
| diameter | Length | Scalar | Circumscribed diameter of telescope aperture | |
| Area | Length² | Scalar | Effective collecting area of telescope | |
Expand All @@ -117,7 +115,7 @@ This mode offers much more flexibility to run the ETC. We refer to our tutorials
| temperature | Temperature | Scalar | Temperature of the warm optics | |
| T_contamination | Dimensionless | Scalar | Effective throughput factor for contamination | |
| pixscale_mas | Milliarcsecond | Scalar | Detector pixel scale | |
| npix_multiplier | Dimensionless | [nlambda] | Number of detector pixels per image plane "pixel" | |
| npix_multiplier | Dimensionless | Scalar | Number of detector pixels per image plane "pixel" | |
| DC | Electron / (Pixel * Second) | [nlambda] | Dark current | |
| RN | Electron / (Pixel * Read) | [nlambda] | Read noise | |
| tread | Second | [nlambda] | Read time | |
Expand Down Expand Up @@ -169,7 +167,7 @@ This mode offers much more flexibility to run the ETC. We refer to our tutorials
| photometric_aperture_throughput | [npix, npix, npsfratios] | Dimensionless | fraction of light entering the coronagraph that ends up within the photometric core of the off-axis (planet) PSF assuming perfectly reflecting/transmitting optics, where the core is the solid angle area `Omega` and is set by either `psf_trunc_ratio` or `photometric_aperture_radius`. | No |
| omega_lod | [npix, npix, npsfratios] | (λ/D)² | Solid angle of the photometric aperture | No |
| skytrans | [npix, npix] | Dimensionless | Sky transmission; the coronagraph’s performance when observing an infinitely extended source | No |
| pixscale | Scalar | λ/D | Pixel scale of the coronagraph model | No |
| pixscale | Scalar | λ/D | Pixel scale of the coronagraph model | Only ToyModel |
| npix | Scalar | Dimensionless | length of one side of the coronagraph model images (assuming a square) | No |
| xcenter | Scalar | Pixel | X-coordinate of the image center | No |
| ycenter | Scalar | Pixel | Y-coordinate of the image center | No |
Expand All @@ -179,15 +177,13 @@ This mode offers much more flexibility to run the ETC. We refer to our tutorials
| npsfratios | Scalar | Dimensionless | Number of PSF truncation ratios (default 1) | No |
| nrolls | Scalar | Dimensionless | Number of roll angles performed | Yes |
| nchannels | Scalar | Dimensionless | Number of channels in coronagraph | Yes |
| minimum_IWA | Scalar | λ/D | Minimum Inner Working Angle | Yes |
| maximum_OWA | Scalar | λ/D | Maximum Outer Working Angle | Yes |
| coronagraph_optical_throughput | [nlambda] | Dimensionless | Throughput for all coronagraph optics | Yes |
| coronagraph_spectral_resolution | Scalar | Dimensionless | Spectral resolution of the coronagraph | Yes |
| contrast | Scalar | Dimensionless | Noise floor contrast of coronagraph | Yes |
| noisefloor_factor | Scalar | Dimensionless | Systematic noise floor factor | Yes |
| noisefloor_PPF | Scalar | Dimensionless | Noise floor post-processing factor | Yes |
| Tcore | Scalar | Dimensionless | Core throughput of coronagraph (used in ToyModel only, or if photometric_aperture_radius is specified for omega_lod calculation) | Yes |
| TLyot | Scalar | Dimensionless | Lyot transmission of the coronagraph (used in ToyModel only) | Yes |
| contrast | Scalar | Dimensionless | Noise floor contrast of coronagraph | Yes (ToyModel only) |
| noisefloor_factor | Scalar | Dimensionless | Systematic noise floor factor | Yes (ToyModel only) |
| noisefloor_PPF | Scalar | Dimensionless | Noise floor post-processing factor | Yes (YIP only) |
| Tcore | Scalar | Dimensionless | Core throughput of coronagraph (used in ToyModel only, or if photometric_aperture_radius is specified for omega_lod calculation) | Yes (ToyModel only) |
| TLyot | Scalar | Dimensionless | Lyot transmission of the coronagraph (used in ToyModel only) | Yes (ToyModel only) |
| PSFpeak | Scalar | Dimensionless | Peak value of the off-axis PSF | No |

### A note on calculating `omega_lod`:
Expand Down Expand Up @@ -215,7 +211,7 @@ where `omega_lod` is the solid angle of the photometric aperture.
| Variable Name | Length | Unit | Meaning | User Editable |
| --------------- | --------- | --------------------------- | ------------------------------------------------- | ------------- |
| pixscale_mas | Scalar | Milliarcsecond | Detector pixel scale | Yes |
| npix_multiplier | [nlambda] | Dimensionless | Number of detector pixels per image plane "pixel" | Yes |
| npix_multiplier | Scalar | Dimensionless | Number of detector pixels per image plane "pixel" | Yes |
| DC | [nlambda] | Electron / (Pixel * Second) | Dark current | Yes |
| RN | [nlambda] | Electron / (Pixel * Read) | Read noise | Yes |
| tread | [nlambda] | Second | Read time | Yes |
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
html_static_path = ["_static"]
html_theme_options = {
"show_toc_level": 2,
"repository_url": "https://github.com/HWO-Project/pyEDITH",
"repository_url": "https://github.com/HabitableWorldsObservatory/pyEDITH",
"path_to_docs": "docs/source",
"use_issues_button": True,
"use_repository_button": True,
Expand Down
21 changes: 9 additions & 12 deletions docs/source/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@
| npsfratios | Integer | Scalar | Number of PSF ratios | |
| nrolls | Integer | Scalar | Number of roll angles | |
| nchannels | Integer | Scalar | Number of channels | |
| minimum_IWA | λ/D | Scalar | Minimum Inner Working Angle | |
| maximum_OWA | λ/D | Scalar | Maximum Outer Working Angle | |

| coronagraph_optical_throughput | Dimensionless | [nlambda] | Throughput for all coronagraph optics | |
| diameter | Length | Scalar | Circumscribed diameter of telescope aperture | |
| Area | Length² | Scalar | Effective collecting area of telescope | |
Expand All @@ -29,7 +28,7 @@
| temperature | Temperature | Scalar | Temperature of the warm optics | |
| T_contamination | Dimensionless | Scalar | Effective throughput factor for contamination | |
| pixscale_mas | Milliarcsecond | Scalar | Detector pixel scale | |
| npix_multiplier | Dimensionless | [nlambda] | Number of detector pixels per image plane "pixel" | |
| npix_multiplier | Dimensionless | Scalar | Number of detector pixels per image plane "pixel" | |
| DC | Electron / (Pixel * Second) | [nlambda] | Dark current | |
| RN | Electron / (Pixel * Read) | [nlambda] | Read noise | |
| tread | Second | [nlambda] | Read time | |
Expand Down Expand Up @@ -91,8 +90,6 @@
| npsfratios | Scalar | Dimensionless | Number of PSF truncation ratios (default 1) | No |
| nrolls | Scalar | Dimensionless | Number of roll angles performed | Yes |
| nchannels | Scalar | Dimensionless | Number of channels in coronagraph | Yes |
| minimum_IWA | Scalar | λ/D | Minimum Inner Working Angle | Yes |
| maximum_OWA | Scalar | λ/D | Maximum Outer Working Angle | Yes |
| coronagraph_optical_throughput | [nlambda] | Dimensionless | Throughput for all coronagraph optics | Yes |
| coronagraph_spectral_resolution | Scalar | Dimensionless | Spectral resolution of the coronagraph | Yes |
| contrast | Scalar | Dimensionless | Noise floor contrast of coronagraph | Yes |
Expand Down Expand Up @@ -127,13 +124,13 @@ where `omega_lod` is the solid angle of the photometric aperture.
| Variable Name | Length | Unit | Meaning | User Editable |
| --------------- | --------- | --------------------------- | ------------------------------------------------- | ------------- |
| pixscale_mas | Scalar | Milliarcsecond | Detector pixel scale | Yes |
| npix_multiplier | [nlambda] | Dimensionless | Number of detector pixels per image plane "pixel" | Yes |
| DC | [nlambda] | Electron / (Pixel * Second) | Dark current | Yes |
| RN | [nlambda] | Electron / (Pixel * Read) | Read noise | Yes |
| tread | [nlambda] | Second | Read time | Yes |
| CIC | [nlambda] | Electron / (Pixel * Photon) | Clock-induced charge | Yes |
| QE | [nlambda] | Electron / Photon | Quantum efficiency of detector | Yes |
| dQE | [nlambda] | Dimensionless | Effective QE due to degradation | Yes |
| npix_multiplier | Scalar | Dimensionless | Number of detector pixels per image plane "pixel" | Yes (Toymodel only) |
| DC | [nlambda] | Electron / (Pixel * Second) | Dark current | Yes (Toymodel only) |
| RN | [nlambda] | Electron / (Pixel * Read) | Read noise | Yes (Toymodel only) |
| tread | [nlambda] | Second | Read time | Yes (Toymodel only) |
| CIC | [nlambda] | Electron / (Pixel * Photon) | Clock-induced charge | Yes (Toymodel only) |
| QE | [nlambda] | Electron / Photon | Quantum efficiency of detector | Yes (Toymodel only) |
| dQE | [nlambda] | Dimensionless | Effective QE due to degradation | Yes (Toymodel only) |


## Within `observation.py`
Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pip install pyedith
Alternatively, you can clone the pyEDITH repository and install it:

```
git clone https://github.com/HWO-Project/pyEDITH.git
git clone https://github.com/HabitableWorldsObservatory/pyEDITH.git
cd pyEDITH
pip install -e .
```
Expand Down
8 changes: 3 additions & 5 deletions inputs/input_toymodel_advanced.edith
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,17 @@ T_optical = 0.362
;epswarmTrcold = 0.638 ; 1.0-T_optical {scalar OR array of length NLD} product of cummulative warm emissivity and cummulative cold transmission (we assume throughput == T_optical for toymodel)

;--- (OVERRIDING DEFAULT) CORONAGRAPH PARAMETERS ---
minimum_IWA = 1.0 ; smallest WA to allow (lambda/D)
maximum_OWA = 60.0 ; largest WA to allow (lambda/D)
contrast = 1.05e-13 ; contrast of coronagraph (uniform over dark hole and unitless)
noisefloor_factor = 0.03 ; 1 sigma systematic noise floor expressed as a multiplicative factor to the contrast (unitless)
bandwidth = 0.2 ; fractional bandwidth of coronagraph (unitless)
core_throughput = 0.2968371 ; core throughput of coronagraph (uniform over dark hole, unitless)
Lyot_transmission = 0.65 ; Lyot transmission of the coronagraph and the factor of 1.6 is just an estimate, used for skytrans
nrolls = 1 ; number of rolls
nchannels = 2 ; number of parallel detection channels (channels evaluated as one contiguous channel)
nchannels = 1 ; number of parallel detection channels (channels evaluated as one contiguous channel)
PSF_trunc_ratio = 0.3

;--- (OVERRIDING DEFAULT) DETECTOR PARAMETERS ---
npix_multiplier = 1 ; number of detector pixels per image plane "pixel"# nlambd array, 1 for detections or spectra w/ ERD, ~6*(140/SR) for spectra with IFS
npix_multiplier = 1 ; number of detector pixels per image plane "pixel"# 1 for detections or spectra w/ ERD, ~6*(140/SR) for spectra with IFS
DC = 3e-5 ; dark current (counts pix^-1 s^-1) (must have same length as lambda)
RN = 0.0 ; read noise (counts pix^-1 read^-1) (must have same length as lambda)
tread = 1000. ; read time (seconds) (must have same length as lambda)
Expand All @@ -86,7 +84,7 @@ secondary_bandwidth = 0.2 ; fractional bandwidth of coronagraph (uni
secondary_core_throughput = 1.22E-01 ; core throughput of coronagraph (uniform over dark hole, unitless)

;--- (OVERRIDING DEFAULT) DETECTOR PARAMETERS ---
secondary_npix_multiplier = 1 ; number of detector pixels per image plane "pixel"# nlambd array, 1 for detections or spectra w/ ERD, ~6*(140/SR) for spectra with IFS
secondary_npix_multiplier = 1 ; number of detector pixels per image plane "pixel", 1 for detections or spectra w/ ERD, ~6*(140/SR) for spectra with IFS
secondary_DC = 3e-5 ; dark current (counts pix^-1 s^-1) (must have same length as lambda)
secondary_RN = 0.0 ; read noise (counts pix^-1 read^-1) (must have same length as lambda)
secondary_tread = 1000. ; read time (seconds) (must have same length as lambda)
Expand Down
Loading
Loading