Welcome to OSAFT’s documentation!#
Welcome to the documentation of the Open Source Acoustofluidics Theory (OSAFT) Library. OSAFT is a Python library for acoustofluidics that implements classical theories focusing on the computation of the acoustic radiation force.
Getting started#
Install the OSAFT package now using pip
pip install osaft
Or go to Installation for more information on the installation process. Learn how to use the package by going to the Examples section. The more detailed documentation can be found in the OSAFT Module section. We are always looking for support in further developing our package. Go to Contributing if you would like to help.
Available Models#
There are currently six different theories available in OSAFT and more are under development. Depending on the theory it is possible to evaluate the scattering field, the streaming field, or the acoustic radiation force of a model.
Name |
Scattering |
Streaming |
ARF |
|---|---|---|---|
✓ |
- |
✓ |
|
✓ |
- |
✓ |
|
- |
- |
✓ |
|
✓ |
- |
✓ |
|
✓ |
- |
✓ |
|
✓ |
- |
✓ |
|
- |
- |
✓ |
|
✓ |
✗ |
✓ |
|
✓ |
✗ |
✗ |
Plotting Functionalities#
OSAFT offers plotting functionalities. Our plotting classes are listed in the Plotting documentation.
Publication / Citing OSAFT#
The module is published in Frontiers in Physics under open-access and
available with this link. If you use the framework please use the following
BibTeX key for referencing OSAFT.
@ARTICLE{Fankhauser2022,
AUTHOR={Fankhauser, Jonas and Goering, Christoph and Dual, Jürg},
TITLE={{OSAFT Library: An Open-Source Python Library for Acoustofluidics}},
JOURNAL={Frontiers in Physics},
VOLUME={10},
YEAR={2022},
URL={https://www.frontiersin.org/article/10.3389/fphy.2022.893686},
DOI={10.3389/fphy.2022.893686},
ISSN={2296-424X},
}