search

Ptychography-4-0 / ptychography

Code repository for Ptychography 4.0 project.
https://ptychography-4-0.github.io/ptychography/
GNU General Public License v3.0
27 stars 14 forks source link

readme

|github| |zenodo| |azure| |precommit|

.. |github| image:: https://img.shields.io/badge/GitHub-GPL--3.0-informational .. _github: https://github.com/Ptychography-4-0/ptychography/

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5055126.svg .. _zenodo: https://doi.org/10.5281/zenodo.5055126

.. |azure| image:: https://dev.azure.com/ptycho40/ptycho40/_apis/build/status/Ptychography-4-0.ptychography?branchName=master .. _azure: https://dev.azure.com/ptycho40/ptycho40/_build/latest?definitionId=1&branchName=master

.. |precommit| image:: https://results.pre-commit.ci/badge/github/Ptychography-4-0/ptychography/master.svg .. _precommit: https://results.pre-commit.ci/latest/github/Ptychography-4-0/ptychography/master

This repository collects implementations for ptychography that result from the work of the Ptychography 4.0 project <https://ptychography.helmholtz-muenchen.de/>_.

Installation

The short version:

.. code-block:: shell

$ virtualenv -p python3.9 ~/ptychography-venv/
$ source ~/ptychography-venv/bin/activate
(ptychography-venv) $ pip install ptychography40

Please see our documentation <https://ptychography-4-0.github.io/ptychography/>_ for details!

Applications

Please see the algorithms section <https://ptychography-4-0.github.io/ptychography/algorithms.html>_ of our documentation for details!

Ptychography 4.0 is evolving rapidly and prioritizes features following user demand and contributions. In the future we'd like to implement more ptychography methods. If you like to influence the direction this project is taking, or if you'd like to contribute <https://ptychography-4-0.github.io/ptychography/contributing.html>, please contact us in the GitHub Issue tracker <https://github.com/Ptychography-4-0/ptychography/issues>.

License

Ptychography 4.0 is licensed under GPLv3.