Weapon of choice for electron ptychographic reconstructions
Project description
phaser: The weapon of choice for ptychographic reconstructions
phaser is a fully-featured package for multislice electron ptychography.
Features
- ePIE, LSQ-MLs, and gradient descent algorithms
numpy,cupy, andjaxbackends.- Single and multislice ptychography
- Multiple incoherent probe modes
- Probe position correction
- Upsampled (sPIE) and segmented ptychography (work in progress)
- Adaptive propagator correction (work in progress)
Installation
To install, first clone the repository from github:
$ git clone https://github.com/hexane360/phaser
# enter phaser directory
$ cd phaser
If you're using cupy or jax with a GPU, follow the installation instructions for those packages.
Then, install with pip:
$ python -m pip install -e .
For the jax or cupy backend, or for the optional webserver, install with the corresponding options:
$ python -m pip install -e '.[cupy,web]' # or '.[jax,web]'
Running
After installation, the phaser command should be available. Phaser can be run from the command line, or through a job server.
To run a single reconstruction on the command line, call phaser run <file>, where file is the path to a reconstruction plan file.
To run the webserver, call phaser serve. By default, the server serves on https://localhost:5050/, so navigate there in a web browser. The server interface can be used to start workers and schedule reconstruction jobs.
To run a worker, call phaser worker <url>, where url is the URL of a running job server.
Alternatives
Other notable ptychography packages:
fold_slicebranch of PtychoShelvespy4DSTEMPtyLab.m/py/jl- PtyPy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file phaserem-0.1.tar.gz.
File metadata
- Download URL: phaserem-0.1.tar.gz
- Upload date:
- Size: 3.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e93b910d1944fc02432ade404044d4f2d07489a34f8d70965fd5178c92db911d
|
|
| MD5 |
361552bf236be910d9b0462c51f18643
|
|
| BLAKE2b-256 |
90925578e47d93899aac970edfd68535e2bb85acdcf4d0fd41623767f55c47f9
|
File details
Details for the file phaserem-0.1-py3-none-any.whl.
File metadata
- Download URL: phaserem-0.1-py3-none-any.whl
- Upload date:
- Size: 3.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5b33a1817e288ca665449ac01c20c212e680dada96fec879bb18c69ca896ed8f
|
|
| MD5 |
754c0ec7c4cf97dd81cffe984574a2dd
|
|
| BLAKE2b-256 |
08681e0507c3939e84c96e602032cacd2f27d753a6ea1c0c25bed65fd9b89cc3
|