From 53c5d1b9e96a37aace566cbbc8369c63430d729d Mon Sep 17 00:00:00 2001 From: Anna Tartaglia Date: Thu, 24 Oct 2024 11:31:40 -0400 Subject: [PATCH] Add assets folder and update docs --- .../data => assets}/jason_mad_eofn.fits | Bin docs/src/{images => assets}/kernel36.png | Bin docs/src/{images => assets}/kernel87.png | Bin docs/src/{images => assets}/speed_boxcar.png | Bin docs/src/{images => assets}/speed_dipole.png | Bin docs/src/{images => assets}/speed_vonmises.png | Bin docs/src/benchmarks.md | 4 ++-- docs/src/tutorials/diffractive.md | 14 +++++++------- docs/src/tutorials/refractive.md | 8 ++++---- 9 files changed, 13 insertions(+), 13 deletions(-) rename docs/src/{tutorials/data => assets}/jason_mad_eofn.fits (100%) rename docs/src/{images => assets}/kernel36.png (100%) rename docs/src/{images => assets}/kernel87.png (100%) rename docs/src/{images => assets}/speed_boxcar.png (100%) rename docs/src/{images => assets}/speed_dipole.png (100%) rename docs/src/{images => assets}/speed_vonmises.png (100%) diff --git a/docs/src/tutorials/data/jason_mad_eofn.fits b/docs/src/assets/jason_mad_eofn.fits similarity index 100% rename from docs/src/tutorials/data/jason_mad_eofn.fits rename to docs/src/assets/jason_mad_eofn.fits diff --git a/docs/src/images/kernel36.png b/docs/src/assets/kernel36.png similarity index 100% rename from docs/src/images/kernel36.png rename to docs/src/assets/kernel36.png diff --git a/docs/src/images/kernel87.png b/docs/src/assets/kernel87.png similarity index 100% rename from docs/src/images/kernel87.png rename to docs/src/assets/kernel87.png diff --git a/docs/src/images/speed_boxcar.png b/docs/src/assets/speed_boxcar.png similarity index 100% rename from docs/src/images/speed_boxcar.png rename to docs/src/assets/speed_boxcar.png diff --git a/docs/src/images/speed_dipole.png b/docs/src/assets/speed_dipole.png similarity index 100% rename from docs/src/images/speed_dipole.png rename to docs/src/assets/speed_dipole.png diff --git a/docs/src/images/speed_vonmises.png b/docs/src/assets/speed_vonmises.png similarity index 100% rename from docs/src/images/speed_vonmises.png rename to docs/src/assets/speed_vonmises.png diff --git a/docs/src/benchmarks.md b/docs/src/benchmarks.md index 0b718e3..5f0dac0 100644 --- a/docs/src/benchmarks.md +++ b/docs/src/benchmarks.md @@ -8,7 +8,7 @@ The Julia implementation of the EHT scattering framework takes advantage of Juli With Julia's speed improvements, the `ScatteringOptics.jl` scattering kernel loads 100 times faster than the `eht-imaging` kernel. The scattering kernel may be called upon to compute visibilities for a given sample of Fourier space points. In these computations, `ScatteringOptics.jl` also exhibits speed improvements up to 100 times over the three included models (Dipole, Boxcar, and Von Mises; see [Use Non-default Models](@ref) for more info) and varying observing wavelengths. These computation runtimes are compared over a range of sample in the plots below. - + With this significant speed up, the Julia implementation allows for the joint modeling of scattering parameters and reconstructed images in self-consistent way. @@ -17,5 +17,5 @@ With this significant speed up, the Julia implementation allows for the joint mo Our scattering kernel produces visibilities that are consistent with those computed by `eht-imaging` across all 3 kernel models as well as the range of standard observing wavelengths in radio astronomy. Below, we demonstrate this by plotting the Dipole kernel over the Fourier space major and minor axis for both the Julia and Python implementations in one plot per observing wavelength. The lines completely overlap, indicating complete consistency in results. All fractional errors between the two implementations range on the order of $10^{-6}$ and $10^{-7}$ (Figure \ref{kernelerrors}), which is well under scattering kernel uncertainty limits. - + diff --git a/docs/src/tutorials/diffractive.md b/docs/src/tutorials/diffractive.md index 548303c..427bc5d 100644 --- a/docs/src/tutorials/diffractive.md +++ b/docs/src/tutorials/diffractive.md @@ -7,7 +7,7 @@ CurrentModule = ScatteringOptics This page describes how to simulate diffractive scattering. ## Loading your image -Here, we use an example image in [`eht-imaging`](https://github.com/achael/eht-imaging). Data can be downloaded from [here](data/jason_mad_eofn.fits). This is a general relativistic magnetohydrodynamic (GRMHD) model of the magnetic arrestic disk originally from [Dexter et al. 2020](https://ui.adsabs.harvard.edu/abs/2020MNRAS.494.4168D/abstract). +Here, we use an example image in [`eht-imaging`](https://github.com/achael/eht-imaging). Data can be downloaded from [here](docs/src/assets/jason_mad_eofn.fits). This is a general relativistic magnetohydrodynamic (GRMHD) model of the magnetic arrestic disk originally from [Dexter et al. 2020](https://ui.adsabs.harvard.edu/abs/2020MNRAS.494.4168D/abstract). ```@example 1 using CairoMakie @@ -17,7 +17,7 @@ using VLBISkyModels # using Comrade # Load a image model from an image FITS file -im = load_fits("data/jason_mad_eofn.fits", IntensityMap) +im = load_fits("docs/src/assets/jason_mad_eofn.fits", IntensityMap) # Plot source image imageviz(im, size=(600, 500), colormap=:afmhot) @@ -124,12 +124,12 @@ The output images may be saved to fits files. Here, we save the images generated ```@example 1 # Ensemble average image of provided EHT fits file -save_fits("data/im_ea.fits", im_ea) +save_fits("docs/src/assets/im_ea.fits", im_ea) # Gaussian model and its scattered ensemble average image -save_fits("data/im_g.fits", im_g) -save_fits("data/im_gea.fits", im_gea) +save_fits("docs/src/assets/im_g.fits", im_g) +save_fits("docs/src/assets/im_gea.fits", im_gea) # Scattering kernel -save_fits("data/im_skm.fits", im_skm) +save_fits("docs/src/assets/im_skm.fits", im_skm) ``` We also save the kernel visibilities calculated in the tutorial. @@ -137,7 +137,7 @@ We also save the kernel visibilities calculated in the tutorial. using HDF5 # Save the computed kernel data -h5open("output_data.h5", "w") do file +h5open("docs/src/assets/kernel.h5", "w") do file file["u"] = collect(u) file["vis"] = vis end diff --git a/docs/src/tutorials/refractive.md b/docs/src/tutorials/refractive.md index cb08481..a2a5d47 100644 --- a/docs/src/tutorials/refractive.md +++ b/docs/src/tutorials/refractive.md @@ -6,7 +6,7 @@ CurrentModule = ScatteringOptics Another feature of `ScatteringOptics.jl` is simulating refractive scattering. This page gives a tutorial to simulate refractive scattering effects. ## Loading your image -Again, we use an example image in [`eht-imaging`](https://github.com/achael/eht-imaging). Data can be downloaded from [here](data/jason_mad_eofn.fits). This is a general relativistic magnetohydrodynamic (GRMHD) model of the magnetic arrestic disk originally from [Dexter et al. 2020](https://ui.adsabs.harvard.edu/abs/2020MNRAS.494.4168D/abstract). +Again, we use an example image in [`eht-imaging`](https://github.com/achael/eht-imaging). Data can be downloaded from [here](docs/src/assets/jason_mad_eofn.fits). This is a general relativistic magnetohydrodynamic (GRMHD) model of the magnetic arrestic disk originally from [Dexter et al. 2020](https://ui.adsabs.harvard.edu/abs/2020MNRAS.494.4168D/abstract). ```@example 1 using CairoMakie @@ -16,7 +16,7 @@ using VLBISkyModels # using Comrade # Load a image model from an image FITS file -im = load_fits("data/jason_mad_eofn.fits", IntensityMap) +im = load_fits("docs/src/assets/jason_mad_eofn.fits", IntensityMap) # Frequency of the image νref = metadata(im).frequency @@ -112,7 +112,7 @@ The output images may be saved to fits files. Here, we save the images generated ```@example 1 # Average image of provided EHT fits file -save_fits("data/im_a.fits", im_a) +save_fits("docs/src/assets/im_a.fits", im_a) # Scattered average image of Gaussian model -save_fits("data/im_ga.fits", im_ga) +save_fits("docs/src/assets/im_ga.fits", im_ga) ```