-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,19 @@ | ||
# BcdiStrain | ||
|
||
<!-- [![Build Status](https://github.com/jmeziere/BcdiStrain.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/jmeziere/BcdiStrain.jl/actions/workflows/CI.yml?query=branch%3Amain) --> | ||
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://byu-cxi.github.io/BcdiStrain.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/BcdiStrain.jl/dev) | ||
|
||
## About | ||
|
||
Bragg Coherent Diffraction Imaging (BCDI) Core implements implements projection-based phase retrieval methods to solve the multi-peak BCDI problem. This package is part of a collection of packages that solve the BCDI problem in various circumstances. | ||
|
||
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. | ||
|
||
Currently, this entire package must be run with access to GPUs. This may change in the future (especially if Issues requesting it are opened), but for our research group, using GPUs is a necessity. | ||
|
||
## Installation | ||
|
||
Currently, BcdiStrain.jl is not registered in the Julia general registry and can be installed by running in the REPL package manager (```]```): | ||
|
||
```add BcdiStrain``` |