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.7.9.tar.gz (57.0 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.7.9-py3-none-any.whl (57.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for barc4beams-2026.7.9.tar.gz
Algorithm Hash digest
SHA256 5bd02dc4e77333b1082c67373a5da6009a34b4736bde722ee0f486375a2d4763
MD5 9b53bb972e7a8ebd704ef3c16d03e910
BLAKE2b-256 8cc95d45e9d1cf333f05619da2ca33565fdaf0b637cf78cdef465d5396f5754a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: barc4beams-2026.7.9-py3-none-any.whl
  • Upload date:
  • Size: 57.3 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.7.9-py3-none-any.whl
Algorithm Hash digest
SHA256 b359ea9c9d27cdf64ebf7eaefaf083bcd166a5264aed3175d7abfd88bc30eec3
MD5 8e8c7266d53fab3b38c041019a92fcbd
BLAKE2b-256 10bd032987e2888867f8e6106fc9d3272ec047cf11b5e452e9fdbb95e592273e

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