Skip to main content

An Open-Source Python Library For Acoustofluidics

Project description

osaft

Coverage PyPi License Pipeline Docs Supported

The OSAFT Python package implements classical theories for the computation of the acoustic scattering, acoustic streaming, and the acoustic radiation force on a particle subjected to an ultrasonic wave. The package provides a unified API that allows for the simple evaluation of quantities often used in the research field of microscale acoustofluidics. Also included in the package are plotting tools (using Matplotlib), so generated results can easily be illustrated.

Installation

All systems with pip/python installed

python -m pip install osaft

If you want to learn more go to the documentation's installation page.

Usage example

Examples how the OSAFT library can be used can be found on our examples page of the documentation.

Publication

A research article (open-access) on the OSAFT library has been published the Frontiers in Physics.

Release History

Find the changes introduced with new releases in the CHANGELOG.md.

License

The distribution is licenced under the GNU Lesser General Public License. See LICENSE.md to learn more.

Contributing

  1. Fork it (https://gitlab.com/acoustofluidics/osaft/-/forks/new)
  2. Create your feature branch (git checkout -b feature/fooBar)
  3. Commit your changes (git commit -am 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new Pull Request

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osaft-1.3.8.tar.gz (2.2 MB view hashes)

Uploaded Source

Built Distribution

osaft-1.3.8-py3-none-any.whl (229.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page