Skip to content
See the acoustic field. A python package to simulate output of phased arrays. Super fast calculations with Huygens model implementation for OpenCL/GPU.
Python C Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build adjusting the visualizers. Note, they are to be factored out to a sep… Aug 20, 2019
demos minor musings Jun 7, 2019
dist update pip installable Jun 7, 2019
handybeam seed the metrics functionality - ported from handybeam-surfaces Sep 26, 2019
.gitignore
.markdownlint.json
.pylintrc
CHANGELOG.rst after amnesia Jun 6, 2019
CONTRIBUTING.rst after amnesia Jun 6, 2019
LICENCE.rst small update in the Licence. Jun 7, 2019
LICENSE create Licence.md Jul 10, 2019
MANIFEST.in
README.rst frontline readme update Jul 9, 2019
changelog.md
gp.cmd after amnesia Jun 6, 2019
how_to_pip.txt
run_docstr_coverage.bat after amnesia Jun 6, 2019
run_show_docs.bat after amnesia Jun 6, 2019
setup.py frontline readme Aug 8, 2019

README.rst

About HandyBeam

See the acoustic field. A python package to simulate output of phased arrays. Super fast calculations with Huygens model implementation for OpenCL/GPU. virtual measurement tools useful for education and research in beam forming, e.g. focal spot size measure, side lobe measures, e.t.c

Do use HandyBeam for:

  • quick visualisation of example acoustic fields, focused, steered, virtual points e.t.c.
  • explore effects of array aperture shape, element count, element density, e.t.c.
  • 3D curved arrays, sparse arrays, and many 'special effects' possible
  • Throw-away checks of what-if scenarios
  • development of task-specific research code
  • demonstrating that we are nice people (e.g. that we know what we are talking about, and that we are open-sourcing things)
  • education, exploration, having fun
  • cool animations and pleasant colours for decorating Your room.

Do not use HandyBeam for:

  • secrets ( instead, clone the repo and do Your development there. Do not push to the public repo. )
  • winning a bad argument (there is that saying - if you want to lie, use statistics. This applies here too.)

Be aware that:

  • HandyBeam model makes many assumptions, which might be an oversimplification of the problem that You are facing.

Things that have been repeatedly asked for, but are waiting in the queue as of now

These are in their order in the queue:

  • time domain propagation simulation engine
  • velocity field calculation (vector field)
  • advanced excitation solvers (bessel beam, sonotweezer)
  • reflections, scattering

Links

None at this moment.

Legal & disclaimer

License

Copyright 2019 Ultrahaptics

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at this location

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

TL;DR disclaimer

  1. If something uncool happens, it's Your fault.
  2. If it breaks, you get to keep both pieces.

HandyBeam is a descendant of cueBeam which was developed between 2008-2018 in University of Strathclyde.

The original source code can be had from here.

Although the core technology is based on the same principles, Note that virtually no source code is shared with cueBEAM. For example, the cueBEAM has been written for Matlab, MEX and CUDA. HandyBeam is a complete rewrite in Python and OpenCl.

Note that as of release R1.0, compatibility with cueBEAM has been completely dropped.


Acknowledgements

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

Contributing

Go to the "Contributing Guide" in the documentation.

Note that as of release R1.0, compatibility with cueBEAM has been completely dropped.


Zen of HandyBeam

  • "There is no point in getting the wrong answer really, really fast" -- speed of code matters, but only after it has been shown to operate correctly.
  • "All that we have is a model" - using simplifying assumptions is OK, just remember to describe the model in the documentation.
  • "Computer simulations are here to make the overall cost of doing the job cheaper, and not more expensive" (Richard O'Leary) -- Do not do time-consuming computations just because You can. Have a reason for spending time and energy.
  • "Things should be made as simple as possible, but not simpler" (Albert Einstein)
  • "There are no unnatural things. There are only things that we do not know about nature"
  • "Everyone knows that something is impossible to do. Then comes that new guy that doesn't know that. And he does it." -- (Zygmunt Wrona, c.a. 1990). -- It is OK to experiment and have random whacky ideas. Also, it's OK to test the common knowledge and challenge authorities.
  • "Nothing is perfect" -- it is OK to be wrong, as long as you invite the chance to get corrected.

Note - all the points have their original authors, whom I sometimes cannot properly attribute. No claim is made to authorship of these.


Documentation

For a first look, see here. Note that this version is only updated periodically, so it could be a bit behind the latest commit.

the sphinx-compilable theory, user manual, and documentation source code is at https://github.com/ultrahaptics/HandyBeam/tree/master/doc/source. This will be corrected to the deployed documentation when I get the space to host it.

You can’t perform that action at this time.