From 2d81b7fc6ab828bd06fce56528ca30114ceac2c4 Mon Sep 17 00:00:00 2001 From: jmeziere Date: Mon, 26 Aug 2024 10:28:54 -0600 Subject: [PATCH] Update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 697d695..3f2e8a3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # BcdiCore -[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://byu-cxi.github.io/BcdiCore.jl/dev) - +[![](https://img.shields.io/badge/Docs-Full-blue.svg)](https://byu-cxi.github.io/BcdiDocs/dev) +[![](https://img.shields.io/badge/Docs-Part-blue.svg)](https://byu-cxi.github.io/BcdiCore.jl/dev) ## About -Bragg Coherent Diffraction Imaging (BCDI) Core implements some of the core functionality used for future projects BcdiAtomic.jl (an atomic scale BCDI solver), BcdiMeso.jl (a mesoscale BCDI Solver), BcdiMulti.jl (a multiscale BCDI solver), BcdiTrad.jl (a BCDI solver using projection algorithms), and BcdiStrain (a BCDI solver for mesoscale using projection algorithms). BcdiCore.jl implements the loss functions and derivatives of loss functions used in these packages. +Bragg Coherent Diffraction Imaging (BCDI) Core implements some of the core functionality used in a suite of julia packages solving the BCDI problem. BcdiCore.jl implements the loss functions and derivatives of loss functions used in these packages. While this package is marked as BCDI specific, the methods are more general and can be used in many phase retrieval problems. In the future, this package may be incorporated into a more general phase retrieval core package.