BOSlib 0.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. BOSlib/__init__.py +9 -0
  2. BOSlib/culculate_refractiveindex.py +89 -0
  3. BOSlib/evaluation.py +344 -0
  4. BOSlib/reconstruction.py +167 -0
  5. BOSlib/reconstruction_utils.py +47 -0
  6. BOSlib/shift.py +126 -0
  7. BOSlib/shift_utils.py +306 -0
  8. BOSlib/utils.py +204 -0
  9. BOSlib-0.0.1.dist-info/LICENSE +674 -0
  10. BOSlib-0.0.1.dist-info/METADATA +84 -0
  11. BOSlib-0.0.1.dist-info/RECORD +13 -0
  12. BOSlib-0.0.1.dist-info/WHEEL +5 -0
  13. BOSlib-0.0.1.dist-info/top_level.txt +1 -0
BOSlib-0.0.1.dist-info/METADATA ADDED
@@ -0,0 +1,84 @@
1
+ Metadata-Version: 2.1
2
+ Name: BOSlib
3
+ Version: 0.0.1
4
+ Summary: the library of Background Oriented Schlieren
5
+ Home-page: https://github.com/ogayuuki0202/BOSlib
6
+ Download-URL: https://github.com/ogayuuki0202/BOSlib
7
+ Author: Yuuki Ogasawara
8
+ Author-email: yukiogasawara.research@gmail.com
9
+ Maintainer: Yuuki Ogasawara
10
+ Maintainer-email: yukiogasawara.research@gmail.com
11
+ License: GNU GENERAL PUBLIC LICENSE,
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.6
16
+ Classifier: Programming Language :: Python :: 3.7
17
+ Classifier: Programming Language :: Python :: 3.8
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3 :: Only
20
+ Classifier: Topic :: Scientific/Engineering
21
+ Classifier: Topic :: Scientific/Engineering :: Visualization
22
+ Classifier: Topic :: Multimedia :: Graphics
23
+ Classifier: Framework :: Matplotlib
24
+ Requires-Python: >=3.6
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Requires-Dist: matplotlib>=3.3.4
28
+ Requires-Dist: numpy<2.0,>=1.20.3
29
+ Requires-Dist: pandas>=1.2.4
30
+ Requires-Dist: scikit-image>=0.24.0
31
+ Requires-Dist: tqdm>=4.0
32
+ Requires-Dist: pillow>=6.0
33
+ Requires-Dist: scipy>=1.0
34
+
35
+ # BOSlib
36
+ # It's still in development so don't use this code!
37
+ 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.
38
+
39
+ ## Key Features
40
+ - Short, concise code for visualization, 3D reconstruction, and quantification
41
+ - GPU parallel processing is also [available](https://github.com/ogayuuki0202/BOSlib-GPU)
42
+
43
+ ## Warning
44
+
45
+ The BOSlib is still in its *beta* state. This means that
46
+ it still might have some bugs and the API may change. However, testing and contributing
47
+ is very welcome, especially if you can contribute with new algorithms and features.
48
+
49
+ ## Installing
50
+ Use PyPI: <https://pypi.python.org/pypi/BOSlib>:
51
+
52
+ pip install BOSlib
53
+
54
+ Or compile from source
55
+
56
+ Download the package from the Github: https://github.com/ogayuuki0202/BOSlib/archive/refs/heads/main.zip
57
+ or clone using git
58
+
59
+ git clone https://github.com/ogayuuki0202/BOSlib.git
60
+ cd BOSlib
61
+ python setup.py install
62
+
63
+
64
+ ## Methods
65
+
66
+ Please see our [Documentation](https://ogayuuki0202.github.io/BOSlib/index.html).
67
+
68
+ ## Getting Started
69
+ Here's a quick example of using BOSlib for flow visualization:
70
+ 1. [3D quantitative visualization and measurement using Abel transform](https://colab.research.google.com/drive/1-Z0ufw8g7u86d0KtyjZTSHDbtDhhknmj?usp=sharing)
71
+ 2. [3D quantitative visualization and measurement using ARTmethod(CT)]()
72
+
73
+ ## Contributors
74
+ - [Yuuki Ogasawara](https://orcid.org/0009-0004-0350-2185)
75
+ - Ayumu Ishibashi
76
+ - Narumi Nose
77
+ - [Shinsuke Udagawa](https://www.researchgate.net/profile/Shinsuke-Udagawa)
78
+ ## How to cite this work
79
+ If you find this project useful, please cite:
80
+
81
+ Yuuki Ogasawara, Ayumu Ishibashi, Shinsuke Udagawa. BOSlib:Background oriented shlieren methods in Python. https://github.com/ogayuuki0202/BOSlib
82
+
83
+ ## How to Contribute
84
+ 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/BOSlib/issues). We also encourage pull requests for new algorithms and improvements to the library.
BOSlib-0.0.1.dist-info/RECORD ADDED
@@ -0,0 +1,13 @@
1
+ BOSlib/__init__.py,sha256=kb_Iy46y664fgo_rYX3A3DnWzsLsMYXPRD3X5SW4-ik,225
2
+ BOSlib/culculate_refractiveindex.py,sha256=v-yIZEtsJchOjO7RFIR3XU4mCYdmbGxKjar03OC5MsA,3421
3
+ BOSlib/evaluation.py,sha256=c0AtR9jz3ShYI-C4PAsHanZAXIsX1d-Le1wdO-fVh0c,12241
4
+ BOSlib/reconstruction.py,sha256=qBxid-wJfsyTfKK1EWa6NejxJ7lHA1HEeIRV6743k98,6545
5
+ BOSlib/reconstruction_utils.py,sha256=hoJQ9crumwdLvmOkIpWasADi2H3-3272P3QPhTrcWu8,1809
6
+ BOSlib/shift.py,sha256=tKBFo-rEPj9BX4070LGdYYRUttRZs1yhJBDwQyWIb0g,5631
7
+ BOSlib/shift_utils.py,sha256=XZ7cwKWV6gkPBcWDkhgU34fRNt1nxAFJNZqC42NIqbk,9397
8
+ BOSlib/utils.py,sha256=ceuHxQmvIsx6z2iudQC9j3SVpQ0m9myTBXuWf6C1eMs,6934
9
+ BOSlib-0.0.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
10
+ BOSlib-0.0.1.dist-info/METADATA,sha256=KdnGZNLmiH4x80Uc_sUz6EWzEPP7QCY_7VCk0PacoqY,3458
11
+ BOSlib-0.0.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
12
+ BOSlib-0.0.1.dist-info/top_level.txt,sha256=ZLqE8iduIk6Ng-LYGvz_faKu-yW4JJwjJpOsXDfBo14,7
13
+ BOSlib-0.0.1.dist-info/RECORD,,
BOSlib-0.0.1.dist-info/WHEEL ADDED
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (75.1.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
BOSlib-0.0.1.dist-info/top_level.txt ADDED
@@ -0,0 +1 @@
1
+ BOSlib