Waveprop

https://pypi.org/project/waveprop/

Admin

Waveprop is a Python simulator for optical wave propagation based on scalar diffraction theory,...

Tokens:1,471

Snippets:22

Trust Score:10

Update:4 months ago

Show doc for...

Tokens:

Raw

### Local Development Setup

Source: https://pypi.org/project/waveprop

Set up a virtual environment, install waveprop in editable mode, and install additional dependencies for development and examples.

```bash
# create virtual environment
conda create -n waveprop_py11 python=3.11
conda activate waveprop

# install
pip install -e .

# for CUDA, check docs for appropriate command: https://pytorch.org/
conda install pytorch torchvision cudatoolkit=11.3 -c pytorch

# for some examples (e.g. holography.py)
pip install joblib imageio click

# run tests
pytest tests/
```

--------------------------------

### Install waveprop

Source: https://pypi.org/project/waveprop

Install the waveprop package using pip.

```bash
pip install waveprop
```

--------------------------------

### New Release and Upload to PyPI

Source: https://pypi.org/project/waveprop

Steps to update the version, create a tag, build the source distribution, and upload the package to PyPI using twine.

```bash
# Update version in setup.py
# Commit and push.

# Create tag and upload
git tag -a vX.X.X -m "Description."
git push origin vX.X.X

# Change version number in setup.py
python setup.py sdist

# Create package and upload to Pypi
twine upload dist/waveprop-X.X.X.tar.gz   
```

--------------------------------

### Generate Holography Pattern

Source: https://pypi.org/project/waveprop

Generates a holography pattern from a target image and propagates it. The target image will be reshaped to a square.

```bash
python examples/holography.py --target data/lcav.png --invert
```

--------------------------------

### Generate Single-Distance Holography Pattern

Source: https://pypi.org/project/waveprop

Generates a holography pattern for a single distance, such as the focal plane. This is useful for creating a GIF with a single image.

```bash
python examples/holography.py --target data/lcav.png --invert --f_lens 0.5 --z_start 0.5 --nz 1
```

Tokens:

Raw