Skip to main content

barc4beams

barc4beams is a Python package providing tools for standardization, statistical analysis, and visualization of (photon) beams from simulation codes such as SHADOW3/4 and PyOptiX. barc4beams also converts intensity maps from wave-optics codes such as SRW and WOFRY.

It offers a data class called Beam, which offers import/export utilities, statistical moment-based analysis, and a consistent plotting API for beam profile, divergence, phase space, and caustic visualization.


Features

  • Import beams from SHADOW3/4, PyOptiX, or intensity maps from SRW / WOFRY
  • Convert to a standard Beam format
  • Compute beam moments, FWHM, skewness, kurtosis, and focal distances
  • Merge and analyze ensembles of beams across runs
  • Propagate beams in free space and build caustics
  • Save and reload beams in HDF5 and JSON formats (stats)
  • Plotting using Matplotlib

See examples/README.md for detailed descriptions of the
three reference notebooks:

  1. Beams from ray-tracing codes
  2. Beam collections and ensembles
  3. Beams from wavefront propagation
    • intensity-based sampling (Rebuffi et al., 2020)
    • phase-aware reconstruction (speckle tracking principles)

Installation

From PyPI:

pip install barc4beams

Documentation Status PyPI License: CeCILL-2.1 DOI

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

barc4beams-2026.6.17.tar.gz (48.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

barc4beams-2026.6.17-py3-none-any.whl (51.0 kB view details)

Uploaded Python 3

File details

Details for the file barc4beams-2026.6.17.tar.gz.

File metadata

  • Download URL: barc4beams-2026.6.17.tar.gz
  • Upload date:
  • Size: 48.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for barc4beams-2026.6.17.tar.gz
Algorithm Hash digest
SHA256 4a80d284cd0cad6019de0293797266937ec01373a47b110b40ab081c394d1e32
MD5 eeed42b248eaccdbfcc6bbb92ce3dd8d
BLAKE2b-256 6e163e616f084193138fd37df66c9241a3d18eff8afedb0892d26043a6d08dfe

See more details on using hashes here.

File details

Details for the file barc4beams-2026.6.17-py3-none-any.whl.

File metadata

  • Download URL: barc4beams-2026.6.17-py3-none-any.whl
  • Upload date:
  • Size: 51.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for barc4beams-2026.6.17-py3-none-any.whl
Algorithm Hash digest
SHA256 04ea407414a517f503f33e47e4ed303df2841b7c492508f08bb0d6677416068b
MD5 5ec2051e11d9d9b5636f67cc442be47e
BLAKE2b-256 7bddd144196da3ddedc7e84bbf06f9e3e4f88ceacbaf1dbf6f7f8d4249d2af0d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page