Skip to main content

the library of Background Oriented Schlieren

Project description

BOSlib

It's still in development so don't use this code!

BOSlib is a library developed to provide open access to various methods of the Background Oriented Schlieren (BOS) method. We are also developing software that runs on a GUI for those who do not have Python skills.

Key Features

  • Short, concise code for visualization, 3D reconstruction, and quantification
  • GPU parallel processing is also available

Warning

The BOSlib is still in its beta state. This means that it still might have some bugs and the API may change. However, testing and contributing is very welcome, especially if you can contribute with new algorithms and features.

Installing

Use PyPI: https://pypi.python.org/pypi/BOSlib:

pip install BOSlib 

Or compile from source

Download the package from the Github: https://github.com/ogayuuki0202/BOSlib/archive/refs/heads/main.zip or clone using git

git clone https://github.com/ogayuuki0202/BOSlib.git
cd BOSlib
python setup.py install 

Methods

Please see our Documentation.

Getting Started

Here's a quick example of using BOSlib for flow visualization:

  1. 3D quantitative visualization and measurement using Abel transform
  2. 3D quantitative visualization and measurement using ARTmethod(CT)

Contributors

How to cite this work

If you find this project useful, please cite:

Yuuki Ogasawara, Ayumu Ishibashi, Shinsuke Udagawa. BOSlib:Background oriented shlieren methods in Python. https://github.com/ogayuuki0202/BOSlib

How to Contribute

We welcome contributions! If you’d like to report a bug or request a feature, please open an issue on our GitHub Issues page. We also encourage pull requests for new algorithms and improvements to the library.

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

boslib-0.0.3.tar.gz (32.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

BOSlib-0.0.3-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

Details for the file boslib-0.0.3.tar.gz.

File metadata

  • Download URL: boslib-0.0.3.tar.gz
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for boslib-0.0.3.tar.gz
Algorithm Hash digest
SHA256 b061ff115316aeb3fbc7f674a93de3dbde95d17bb4bac85e17b7920d4957bfb4
MD5 f2696b3eaf73cb5afbcca7f19321970c
BLAKE2b-256 137ed26f9ea8996298e32da4831086b67af270fa94f7dda58eda4127caaf6f99

See more details on using hashes here.

File details

Details for the file BOSlib-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: BOSlib-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 33.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for BOSlib-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 db4055158a54b70e7838ab8d14bc6d13a46f6339cdfaf58a873aa8f755caab3d
MD5 41b67fd7a4626953abcdecdc53b36b22
BLAKE2b-256 892253922c3491a7d8f254842c2701cc6b667c684322082797f0a79eb0d0529a

See more details on using hashes here.

Supported by

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