HandyBeam
'v0'-1-gd0b5036

Theory:

  • Philosophy
  • Code organisation
  • API principles
  • Theory
  • Contributing guide
  • Contributors
  • Links

Practice:

  • Installation
  • Quick start examples
  • Implementation
  • Data structures manual
  • Data structures
  • Data collection and privacy
  • API reference
    • handybeam.world
    • handybeam.tx_array
    • handybeam.tx_array_library
    • handybeam.excitation_solver
    • handybeam.translator
    • handybeam.samplers
    • handybeam.visualize
    • handybeam.evaluators
    • handybeam.opencl_wrappers
    • handybeam.cl_system
    • cl_platform_config.ini
    • handybeam.misc
    • handybeam.remember_instance_creation_info
    • handybeam.bugcatcher
    • __init__.py
  • Frontier API
    • handybeam.propagator
    • handybeam.propagators
  • Obsolete code reference
    • handybeam.tx_element
    • Misc obsolete code
    • handybeam.sampler_abstract
    • handybeam.sampler_abstract_ortho
    • handybeam.sampler_plane_xy
    • handybeam.sampler_plane_yz
    • handybeam.sampler_point_list
    • OpenCL kernel : “clist”
    • OpenCL kernel : “cxyz”
  • Tests reference
    • tx_element
HandyBeam
  • Docs »
  • API reference
  • View page source

Welcome

API reference¶

API

  • handybeam.world
  • handybeam.tx_array
  • handybeam.tx_array_library
  • handybeam.excitation_solver
  • handybeam.translator
  • handybeam.samplers
  • handybeam.visualize
  • handybeam.evaluators
  • handybeam.opencl_wrappers
  • handybeam.cl_system
  • cl_platform_config.ini
  • handybeam.misc
  • handybeam.remember_instance_creation_info
  • handybeam.bugcatcher
  • __init__.py

Frontier API¶

Frontier API

  • handybeam.propagator
  • handybeam.propagators

Obsolete code reference¶

Obsoletes

  • handybeam.tx_element
  • Misc obsolete code
  • handybeam.sampler_abstract
  • handybeam.sampler_abstract_ortho
  • handybeam.sampler_plane_xy
  • handybeam.sampler_plane_yz
  • handybeam.sampler_point_list
  • OpenCL kernel : “clist”
    • Introduction
  • OpenCL kernel : “cxyz”
    • Introduction

Tests reference¶

Tests

  • tx_element

that’s all I have for You …


Back to Welcome

Licence (documentation): Creative Commons CC BY-NC-SA 4.0

Licence (source code): Apache 2.0

EU logo

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 737087.


This project has received funding from Ultrahaptics.

Ultrahaptics logo
Next Previous

© Copyright Ultrahaptics 2018-2019. Documentation License: Creative Commons CC BY-NC-SA 4.0

Built with Sphinx using a theme provided by Read the Docs.