hfpytrace.density.gemini¶
Package
GEMINI model adapter for 2D and 3D electron density grid workflows.
Key Classes¶
Class GEMINI2d
Key Methods¶
Method GEMINI2d.fetch_dataset()
Method GEMINI2d.fetch_dataset_3d()
API¶
hfpytrace.density.gemini
¶
GEMINI electron density reader.
Reads GEMINI (Geospace Environment Model of Ion-Neutral Interactions) HDF5 output files and interpolates the electron density onto arbitrary lat/lon/altitude grids for use in HF ray-tracing.
Requires¶
h5py, pandas : for HDF5 I/O and grid operations.
Classes¶
GEMINI2d
Loads GEMINI HDF5 output files and provides fetch_dataset /
fetch_dataset_3d methods that resample Ne onto user-specified grids.
GEMINI2d
¶
Bases: object
Electron density from GEMINI simulation output.
Reads GEMINI HDF5 output and interpolates electron density to requested
(lat, lon, alt) grids. The grid coordinate file (cfg.grid_coordinate_file)
is loaded once; individual time-step files are matched by wall-clock time.
Parameters¶
SimpleNamespace
Config with density_file_location, density_file_name (glob
pattern for data files), grid_coordinate_file (HDF5 coordinate
file), scale, and kind (interpolation scale/kind).
datetime.datetime
Reference event time; the nearest file timestamp is used.
Source code in hfpytrace/density/gemini.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | |
search_mat_files()
¶
Search all files
Source code in hfpytrace/density/gemini.py
load_grid()
¶
Load grid file
Source code in hfpytrace/density/gemini.py
load_data(fname)
¶
Load electron density array from a single GEMINI HDF5 time-step file.
Parameters¶
str
Path to the HDF5 data file.
Returns¶
pandas.DataFrame
Grid DataFrame extended with a nsall column (electron density in m⁻³).
Source code in hfpytrace/density/gemini.py
fetch_dataset(time, lats, lons, alts, to_file=None, dlat=0.2, dlon=0.2, intp_edens_xlim_index=0)
¶
Fetch 2D electron density along a route at a given time.
The nearest GEMINI time-step file is selected. For each route point
(lat, lon), grid cells within ±dlat / ±dlon are averaged
and then altitude-interpolated.
Parameters¶
datetime.datetime
Requested time snapshot.
lats, lons : array-like, shape (npts,) Geographic coordinates of route points [°].
array-like, shape (nalt,)
Target altitude levels [km].
str, optional
If given, save the result to a .mat file at this path.
dlat, dlon : float
Half-width of the spatial averaging box [°]. Default 0.2.
int
If > 0, all columns from this index onward are filled by repeating the column at this index (useful for extending the ionosphere past the GEMINI domain boundary).
Returns¶
np.ndarray, shape (nalt, npts)
Electron density in cm⁻³.
array-like
The alts argument (returned for caller convenience).
Source code in hfpytrace/density/gemini.py
fetch_dataset_3d(time, lats, lons, alts, to_file=None, workers=1, dlat=0.2, dlon=0.2)
¶
Fetch 3D electron density cube on (lat, lon, alt) with optional point-wise parallelism.
Source code in hfpytrace/density/gemini.py
load_from_file(to_file)
¶
Load a previously saved electron density array from a .mat file.
Parameters¶
str
Path to the .mat file containing key ne.
Returns¶
np.ndarray Electron density array as stored.
Source code in hfpytrace/density/gemini.py
Source Code¶
| hfpytrace/density/gemini.py | |
|---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | |