<div align="center">
<img src="docs/assets/images/holab_logo.png" alt="logo"></img>
<p><i>Hologram Optimization Laboratory</i></p>
</div>
Holab is a tool for designing acoustic lenses that generate arbitrarily complex holograms. It is written on top of `jax` and `jwave` to allow for fast GPU computations, as well as to guarantee great flexibility in designing the holograms and the lenses requiremends, using automatic differentiation.
## Install
To install the `holab`, make sure that you have [installed jax with GPU support](https://github.com/google/jax#installation). Then, simply use
```bash
pip install holab
```
## Getting started
Please visit the [documentation](https://github.com/ucl-bug/holab/) for a detailed description of the software and its usage. An example is provided [as a jupyter notebook](docs/example.ipynb).
<br/>
## Citation
```bibtex
@misc{stanziola2023physicsbased,
title={Physics-Based Acoustic Holograms},
author={Antonio Stanziola and Ben T. Cox and Bradley E. Treeby and Michael D. Brown},
year={2023},
eprint={2305.03625},
archivePrefix={arXiv},
primaryClass={cs.SD}
}
```
<br/>
## Related projects
- [jolab](https://github.com/DylanMMarques/Jolab.jl): Jolab is a free and open-source Julia package to simulate light propagation in optical systems. From Dylan Marques et al.
- [jwave](https://github.com/ucl-bug/jwave): A JAX-based research framework for differentiable and parallelizable acoustic simulations, on CPU, GPUs and TPUs.
Raw data
{
"_id": null,
"home_page": "",
"name": "holab",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "jax,acoustics,simulation,hologram,ultrasound",
"author": "Antonio Stanziola",
"author_email": "a.stanziola@ucl.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/ec/ca/fcc3b7fd6ebf52ec42c667f3400c86ddf7bbb969dbec092a3d29101781b5/holab-0.0.3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<img src=\"docs/assets/images/holab_logo.png\" alt=\"logo\"></img>\n<p><i>Hologram Optimization Laboratory</i></p>\n</div>\n\nHolab is a tool for designing acoustic lenses that generate arbitrarily complex holograms. It is written on top of `jax` and `jwave` to allow for fast GPU computations, as well as to guarantee great flexibility in designing the holograms and the lenses requiremends, using automatic differentiation.\n\n## Install\n\nTo install the `holab`, make sure that you have [installed jax with GPU support](https://github.com/google/jax#installation). Then, simply use\n\n```bash\npip install holab\n```\n\n## Getting started\n\nPlease visit the [documentation](https://github.com/ucl-bug/holab/) for a detailed description of the software and its usage. An example is provided [as a jupyter notebook](docs/example.ipynb).\n\n<br/>\n\n## Citation\n\n```bibtex\n@misc{stanziola2023physicsbased,\n title={Physics-Based Acoustic Holograms},\n author={Antonio Stanziola and Ben T. Cox and Bradley E. Treeby and Michael D. Brown},\n year={2023},\n eprint={2305.03625},\n archivePrefix={arXiv},\n primaryClass={cs.SD}\n}\n```\n\n<br/>\n\n## Related projects\n- [jolab](https://github.com/DylanMMarques/Jolab.jl): Jolab is a free and open-source Julia package to simulate light propagation in optical systems. From Dylan Marques et al.\n- [jwave](https://github.com/ucl-bug/jwave): A JAX-based research framework for differentiable and parallelizable acoustic simulations, on CPU, GPUs and TPUs.\n",
"bugtrack_url": null,
"license": "LGPL-3.0-only",
"summary": "Acoustic lens design on GPUs with Automatic Differentiation.",
"version": "0.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/ucl-bug/holab/issues",
"Homepage": "https://github.com/ucl-bug/holab",
"Repository": "https://github.com/ucl-bug/holab",
"Support": "https://github.com/ucl-bug/holab/issues"
},
"split_keywords": [
"jax",
"acoustics",
"simulation",
"hologram",
"ultrasound"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06e5472a2a55fc96fb1158f5cd443b326be5c3d54cb6700359ea1112a9e72a09",
"md5": "c2434142cccb7aa3db669bd590c839ef",
"sha256": "49079cca2cbeeb8c53400d04ba0166ea5373db23d9cd6aa6f0478a0d679c7e5a"
},
"downloads": -1,
"filename": "holab-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c2434142cccb7aa3db669bd590c839ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 12192,
"upload_time": "2023-09-04T16:17:08",
"upload_time_iso_8601": "2023-09-04T16:17:08.866430Z",
"url": "https://files.pythonhosted.org/packages/06/e5/472a2a55fc96fb1158f5cd443b326be5c3d54cb6700359ea1112a9e72a09/holab-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eccafcc3b7fd6ebf52ec42c667f3400c86ddf7bbb969dbec092a3d29101781b5",
"md5": "bd3ebba406c4b10401f5b4ed80b256f2",
"sha256": "591dd8b86a0ae7713b6ecd06f6b20b4d040759951cc680cb38a57baf7f8b343d"
},
"downloads": -1,
"filename": "holab-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "bd3ebba406c4b10401f5b4ed80b256f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 11396,
"upload_time": "2023-09-04T16:17:10",
"upload_time_iso_8601": "2023-09-04T16:17:10.883382Z",
"url": "https://files.pythonhosted.org/packages/ec/ca/fcc3b7fd6ebf52ec42c667f3400c86ddf7bbb969dbec092a3d29101781b5/holab-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-04 16:17:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ucl-bug",
"github_project": "holab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "holab"
}
JSON
