add link to each doc section

byu-cxi · Aug 26, 2024 · c6d7128 · c6d7128
1 parent 0df0a73
commit c6d7128
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -4,16 +4,16 @@
 
 The BYU-CXI research group maintains a suite of Julia packages to solve the Bragg Coherent Diffraction Imaging (BCDI) problem in several different regimes and circumstance. 
 
-- BcdiCore.jl ([github repo](https://github.com/byu-cxi/BcdiCore.jl)) implements all of the Fourier transforms for the Julia BCDI packages. In addition, BcdiCore calculates the loss function used (either ``L_2`` or the MLE estimator) and derivatives of these loss functions.
+- [BcdiCore.jl](https://byu-cxi.github.io/BcdiDocs/dev/BcdiCore.jl/docs/src/) ([github repo](https://github.com/byu-cxi/BcdiCore.jl)) implements all of the Fourier transforms for the Julia BCDI packages. In addition, BcdiCore calculates the loss function used (either ``L_2`` or the MLE estimator) and derivatives of these loss functions.
 
-- BcdiTrad.jl ([github repo](https://github.com/byu-cxi/BcdiTrad.jl)) implements projection-based BCDI algorithm. Currently, this is limited to ER, HIO, and shrinkwrap. 
+- [BcdiTrad.jl](https://byu-cxi.github.io/BcdiDocs/dev/BcdiTrad.jl/docs/src/) ([github repo](https://github.com/byu-cxi/BcdiTrad.jl)) implements projection-based BCDI algorithm. Currently, this is limited to ER, HIO, and shrinkwrap. 
 
-- BcdiStrain.jl ([github repo](https://github.com/byu-cxi/BcdiStrain.jl)) implements a multi-peak BCDI algorithm developed by the BYU-CXI group. In addition to the alogrithms present in BcdiTrad, BcdiStrain also implements Mount, an operator that switches between peaks.
+- [BcdiStrain.jl](https://byu-cxi.github.io/BcdiDocs/dev/BcdiStrain.jl/docs/src/) ([github repo](https://github.com/byu-cxi/BcdiStrain.jl)) implements a multi-peak BCDI algorithm developed by the BYU-CXI group. In addition to the alogrithms present in BcdiTrad, BcdiStrain also implements Mount, an operator that switches between peaks.
 
-- BcdiMeso.jl ([github repo](https://github.com/byu-cxi/BcdiMeso.jl)) implements a BCDI algorithm that solves in the mesoscale regime. Instead of using projections, this algorithm uses a gradient-based optimization scheme. Additionally, BcdiMeso does not assume a small measurement distance away from the peak.
+- [BcdiMeso.jl](https://byu-cxi.github.io/BcdiDocs/dev/BcdiMeso.jl/docs/src/) ([github repo](https://github.com/byu-cxi/BcdiMeso.jl)) implements a BCDI algorithm that solves in the mesoscale regime. Instead of using projections, this algorithm uses a gradient-based optimization scheme. Additionally, BcdiMeso does not assume a small measurement distance away from the peak.
 
 - BcdiAtomic.jl is an upcoming BCDI package that implements a BCDI algorithm that solves at the atomic scale.
 
 - BcdiMulti.jl is an upcoming BCDI package that implements a multiscale BCDI algorithm that solves at both the mesoscale and the atomic scale.
 
-- BcdiSimulate.jl ([github repo](https://github.com/byu-cxi/BcdiSimulate.jl)) implements algorithms that simulate the BCDI problem. Currently, this is only implimented at the atomic scale.
+- [BcdiSimulate.jl](https://byu-cxi.github.io/BcdiDocs/dev/BcdiSimulate.jl/docs/src/) ([github repo](https://github.com/byu-cxi/BcdiSimulate.jl)) implements algorithms that simulate the BCDI problem. Currently, this is only implimented at the atomic scale.