Metadata-Version: 2.1
Name: openBOS
Version: 0.0.6
Summary: the library of Background Oriented Schlieren
Home-page: https://github.com/ogayuuki0202/openBOS
Download-URL: https://github.com/ogayuuki0202/openBOS
Author: Yuuki Ogasawara
Author-email: yukiogasawara.research@gmail.com
Maintainer: Yuuki Ogasawara
Maintainer-email: yukiogasawara.research@gmail.com
License: GNU GENERAL PUBLIC LICENSE,
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Multimedia :: Graphics
Classifier: Framework :: Matplotlib
Requires-Python: >=3.6
License-File: LICENSE
Requires-Dist: matplotlib >=3.3.4
Requires-Dist: numpy <2.0,>=1.20.3
Requires-Dist: pandas >=1.2.4
Requires-Dist: scikit-image >=0.24.0
Requires-Dist: tqdm >=4.0
Requires-Dist: metpy >=1.6

# openBOS
openBOS 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.
# under construction! don't use codes. we will finish the developing soon.

## Key Features
- nothing

## Warning

The openBOS python version 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/openBOS>:

    pip install openBOS 

### To build from source

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

    git clone https://github.com/ogayuuki0202/openBOS.git

For the global installation, use:

    python setup.py install 


## Methods

Please see our wiki below.
[Wiki](https://github.com/ogayuuki0202/openBOS/wiki)

## Getting Started
Here's a quick example of using openBOS for flow visualization:
1. [Quick visualization]()
2. [Three dimentionally reconstruction]()

## Contributors
1. [Yuuki Ogasawara](https://orcid.org/0009-0004-0350-2185)
2. Ayumu Ishibashi 
3. Narumi Nose
3. [Shinsuke Udagawa](https://www.researchgate.net/profile/Shinsuke-Udagawa)
## How to cite this work
If you find this project useful, please cite:

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

## 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](https://github.com/ogayuuki0202/openBOS/issues). We also encourage pull requests for new algorithms and improvements to the library.


