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

Uploaded Python 3

File details

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

File metadata

  • Download URL: barc4beams-2026.6.22.tar.gz
  • Upload date:
  • Size: 52.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.6.22.tar.gz
Algorithm Hash digest
SHA256 1a34b35d2830b15bbe912d5317b4d4377e097da6472e618f6abcc2ef85d9ebe6
MD5 6f05de994516a97da08804c421651dc5
BLAKE2b-256 f19256e13e383c8c3c267157a97efd50307a2b85ef55bb89f292446bedbd3305

See more details on using hashes here.

File details

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

File metadata

  • Download URL: barc4beams-2026.6.22-py3-none-any.whl
  • Upload date:
  • Size: 53.6 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.22-py3-none-any.whl
Algorithm Hash digest
SHA256 4411fd1bc312771b74d1fc5cb337034d2838561c9e5cc0ecb3447026ceea178d
MD5 62dfc9c780bf0880f3eacae61d20b9ba
BLAKE2b-256 80590d1dce2e239c6e77dd021b090961368ff18f2ea9ac6124ccbd64bd119c41

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