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.22.tar.gz (57.2 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.22-py3-none-any.whl (56.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: barc4beams-2026.7.22.tar.gz
  • Upload date:
  • Size: 57.2 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.22.tar.gz
Algorithm Hash digest
SHA256 4cd0d53e50c3336d4f4a1330ef158e92eb954da77917802bd7d408c6253c283c
MD5 5f669d49e3c51480a0222747c27bc022
BLAKE2b-256 fc2a0bf30fd0c9a4ddc71bbcf891ab31bff523db045426eb9f81f8edf3ede191

See more details on using hashes here.

File details

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

File metadata

  • Download URL: barc4beams-2026.7.22-py3-none-any.whl
  • Upload date:
  • Size: 56.5 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.22-py3-none-any.whl
Algorithm Hash digest
SHA256 e0beb6ce49e2f4a117e4b7f14a47e1e4a983e75316e240d3ee7b673d611b9c5f
MD5 56bc0aff433a86015c44b0669554f216
BLAKE2b-256 eb71681eea1857332c65ca24752ca3a5a9c9c30ea2b40959e85f1d7fcd0b56e9

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