Skip to main content

spexwavepy

An open-source Python package for X-ray wavefront sensing using speckle-based techniques

Spexwavepy is an open-source Python package dedicated to the speckle-based wavefront sensing techniques for X-ray optics. Its name is the abbreviation of the speckle-based X-ray wavefront sensing Python package.

Features

  • spexwavepy is dedicated to the speckle-based X-ray wavefront sensing techniques.
  • It provides various data processing modes.
  • It is written in Python and open-source.
  • It uses the built-in multiprocessing module to parallelise the code.
  • It has a complete Documentation for the package.
  • It shares the expriment data used for the examples.

Getting spexwavepy

1. From GitHub

This is the recommended way of getting this package. Since in this way, the users will have the example code and also the compiled documentation in the form of html files.

Git clone from the GitHub repository.

git clone https://github.com/wholingfei/spexwavepy.git

cd spexwavepy

pip install -e .

Or, if you have difficulties in using pip install due to various reasons, make sure you have Numpy, Scipy, cv2(opencv-python) and natsort available, you can use this package without installation as well.

2. From PyPI

pip install spexwavepy

This can install the package without the provided examples.

Documentation

There are two ways of reading the documentation of this package.

If you download the source code of this package from GitHub, you can find the local documentation in docs/build/html/ folder. Read them using your web browser. Further, you can make the html pages from make file.

make clean

and

make html

will generate the documentation in html files.

The documentation can also be found online.

The main page of the documention is host at readthedocs.org.

Data availability

All the data used in spexwavepy is shared on Zenodo, https://zenodo.org/records/10892838. Users can download the data and reproduce all the results from the example code by themselves.

Metadata

Release files for spexwavepy 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spexwavepy 1.0.1
File Size Uploaded Provenance Actions
spexwavepy-1.0.1.tar.gz 31.3 kB Without provenance Details for spexwavepy-1.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for spexwavepy 1.0.1
File Interpreter ABI Platform Actions
spexwavepy-1.0.1-py3-none-any.whl Python 3 none any Details for spexwavepy-1.0.1-py3-none-any.whl

Total release size: 62.8 kB

Release files / spexwavepy-1.0.1.tar.gz

Download URL spexwavepy-1.0.1.tar.gz
Size 31.3 kB
Tags Source
SHA-256 checksum
How to use checksums
81d33371f6d5265fae984e919cf595d82463481c85648ef13cf5fd3f21cc7bb8
BLAKE2b-256 checksum
How to use checksums
61760b186b6e97b5c3e4ee2181832fbdb9514bb20f48f06add3037611811ff5e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.7

Release files / spexwavepy-1.0.1-py3-none-any.whl

Download URL spexwavepy-1.0.1-py3-none-any.whl
Size 31.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a40200cd9d17ff5b4836c7e8a98515280bc39bf24815ec7559d24d112d07ff27
BLAKE2b-256 checksum
How to use checksums
3bc558b29c6c081fc8ba20792a9fddf6a936bd3c3cb99e7e1befb4c362f0a5ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.7

Security for spexwavepy 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page