Skip to content

Commit

Permalink
Release notes for 0.8 (#532)
Browse files Browse the repository at this point in the history
* started draft for release notes for 0.8

* updated message about threepie

* updated release notes
  • Loading branch information
daurer authored Feb 2, 2024
1 parent a7b635d commit a0a4b7e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions release_notes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# PtyPy 0.8 release notes

We're excited to bring you a new release, with new engines, CuPy support and
other improvements.

## GPU acceleration

An alternative CUDA implementation based on [`cupy`](https://cupy.dev/)
has been implemented, providing the same feature as the `PyCuda` based
engine.
Expand All @@ -8,6 +13,24 @@ It can be imported using
import ptypy
ptypy.load_gpu_engines('cupy')
```
which will load engines such as ```DM_cupy```, ```RAAR_cupy```, ```ML_cupy```, ```EPIE_cupy``` and ```SDR_cupy```.


## Engine updates

* New WASP algorithm including GPU acceleration, available as custom engines by importing the module from ```ptypy.custom``` (thanks to Timothy Poon)
* Experimental implementation of the ThreePIE algorithm (multislice) which is available as custom engine by importing the module
```ptypy.custom.threepIE``` and using the engine as ```ThreePIE``` (thanks to Yiran Lu and Maik Kahnt)
* We provide templates for both algorithms, we are working on additional documentation

## Additional build changes

* Added Euclidean noise model to core ML engine (thanks to Jari Fowkes)
* New saving mode "used_params" that will save parameters used during reconstruction into the output .ptyr file
* Introducing core functions ```copy_state``` and ```restore_data``` which allow for more efficient parameter sweeps

## Breaking change
Removed NCCL support from pycuda engines to avoid dependency on CuPy. The new CuPy engines have been implemented with NCCL support.


# PtyPy 0.7.1 release notes
Expand Down

0 comments on commit a0a4b7e

Please sign in to comment.