Skip to content

Commit 2d81b7f

Browse files
committed
Update readme
1 parent c6feb4b commit 2d81b7f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# BcdiCore
22

33
<!-- [![Build Status](https://github.com/jmeziere/BcdiCore.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/jmeziere/BcdiCore.jl/actions/workflows/CI.yml?query=branch%3Amain) -->
4-
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://byu-cxi.github.io/BcdiCore.jl/dev)
5-
<!-- [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://byu-cxi.github.io/BcdiCore.jl/stable) -->
4+
[![](https://img.shields.io/badge/Docs-Full-blue.svg)](https://byu-cxi.github.io/BcdiDocs/dev)
5+
[![](https://img.shields.io/badge/Docs-Part-blue.svg)](https://byu-cxi.github.io/BcdiCore.jl/dev)
66

77
## About
88

9-
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.
9+
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.
1010

1111
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.
1212

0 commit comments

Comments
 (0)