Welcome to the repository of Pty-chi, a PyTorch-based ptychography reconstruction library!

Installation

Standard installation

The easiest way to install the latest release is through PyPI. First, create a new conda environment with Python 3.11:

conda create -n ptychi python=3.11

Then install Pty-Chi using:

pip install ptychi

Developer installation

To install the latest code in the main branch, clone the repository to your workspace, and create a new conda environment using:

conda create -n ptychi -c conda-forge -c nvidia --file requirements-dev.txt

Then install the package using:

pip install -e .

How to run test scripts

1. Contact the developers to be given access to the APS GitLab repository that holds test data. You need to have an account on APS GitLab.
2. After gaining access, clone the GitLab data repository to your hard drive.
3. Set PTYCHO_CI_DATA_DIR to the ci_data directory of the data repository: export PTYCHO_CI_DATA_DIR="path_to_data_repo/ci_data".
4. Run any test scripts in tests with Python.

Reading documentations

Pty-Chi's documentation is hosted on Read the Docs.

You can also build the docs and view them in your browser locally. To build the docs, install the dependencies as the first step:

pip install -r docs/requirements.txt

Then:

cd docs
make html

You can then view the docs by opening docs/build/html/index.html in your browser.

Developer's Guide

Please refer to the developer's guide for more information on how to contribute to the project. The developer's guide is hosted on the Wiki page of Pty-Chi's APS GitLab repository. To gain access to the APS GitLab repository, please contact the developers.