arcjetCV 1.1.0.dev3__tar.gz → 1.1.0.dev5__tar.gz

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 (59) hide show
  1. arcjetcv-1.1.0.dev5/MANIFEST.in +1 -0
  2. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/PKG-INFO +7 -5
  3. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/README.md +4 -4
  4. arcjetcv-1.1.0.dev5/README_pypi.md +135 -0
  5. arcjetcv-1.1.0.dev5/arcjetCV/calibration/calibration_controller.py +908 -0
  6. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/calibration_view.py +68 -66
  7. arcjetcv-1.1.0.dev5/arcjetCV/calibration/test.py +70 -0
  8. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/arcjetCV_gui.py +23 -11
  9. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/main.py +12 -3
  10. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/main_window.py +125 -70
  11. arcjetcv-1.1.0.dev5/arcjetCV/utils/utils.py +192 -0
  12. {arcjetcv-1.1.0.dev3/arcjetCV.egg-info → arcjetcv-1.1.0.dev5/arcjetcv.egg-info}/PKG-INFO +7 -5
  13. {arcjetcv-1.1.0.dev3/arcjetCV.egg-info → arcjetcv-1.1.0.dev5/arcjetcv.egg-info}/SOURCES.txt +10 -6
  14. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/setup.py +2 -2
  15. arcjetcv-1.1.0.dev5/tests/chessboard_pattern.png +0 -0
  16. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/tests/test_calibration_functions.py +66 -17
  17. arcjetcv-1.1.0.dev5/tests/test_calibration_gui.py +68 -0
  18. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/tests/test_gui.py +12 -12
  19. arcjetcv-1.1.0.dev3/arcjetCV/calibration/calibration_controller.py +0 -891
  20. arcjetcv-1.1.0.dev3/arcjetCV/utils/utils.py +0 -160
  21. arcjetcv-1.1.0.dev3/tests/test_calibration_gui.py +0 -60
  22. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/LICENSE +0 -0
  23. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/__init__.py +0 -0
  24. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/__init__.py +0 -0
  25. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/calibrate_video.py +0 -0
  26. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/calibration_main.py +0 -0
  27. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/calibration_model.py +0 -0
  28. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/chessboard_pattern.png +0 -0
  29. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/detetct_example.py +0 -0
  30. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/calibration/rotated_pattern.png +0 -0
  31. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/chessboard_pattern.png +0 -0
  32. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/__init__.py +0 -0
  33. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/_arcjetCV_gui.py +0 -0
  34. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/custom_classes.py +0 -0
  35. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/logo/arcjetCV_logo.icns +0 -0
  36. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/logo/arcjetCV_logo.ico +0 -0
  37. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/logo/arcjetCV_logo_.png +0 -0
  38. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/gui/logo/arcjetCV_logo_white.png +0 -0
  39. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/segmentation/__init__.py +0 -0
  40. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/segmentation/contour/__init__.py +0 -0
  41. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/segmentation/contour/cnn.py +0 -0
  42. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/segmentation/contour/contour.py +0 -0
  43. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/segmentation/time/__init__.py +0 -0
  44. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/segmentation/time/time_segmentation.py +0 -0
  45. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/utils/__init__.py +0 -0
  46. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/utils/logger.py +0 -0
  47. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/utils/output.py +0 -0
  48. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/utils/processor.py +0 -0
  49. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/arcjetCV/utils/video.py +0 -0
  50. {arcjetcv-1.1.0.dev3/arcjetCV.egg-info → arcjetcv-1.1.0.dev5/arcjetcv.egg-info}/dependency_links.txt +0 -0
  51. {arcjetcv-1.1.0.dev3/arcjetCV.egg-info → arcjetcv-1.1.0.dev5/arcjetcv.egg-info}/entry_points.txt +0 -0
  52. {arcjetcv-1.1.0.dev3/arcjetCV.egg-info → arcjetcv-1.1.0.dev5/arcjetcv.egg-info}/requires.txt +0 -0
  53. {arcjetcv-1.1.0.dev3/arcjetCV.egg-info → arcjetcv-1.1.0.dev5/arcjetcv.egg-info}/top_level.txt +0 -0
  54. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/setup.cfg +0 -0
  55. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/tests/README.md +0 -0
  56. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/tests/__init__.py +0 -0
  57. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/tests/test_functions.py +0 -0
  58. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/tests/test_obj_models.py +0 -0
  59. {arcjetcv-1.1.0.dev3 → arcjetcv-1.1.0.dev5}/tests/test_segmentation.py +0 -0
@@ -0,0 +1 @@
1
+ include README_pypi.md
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
- Name: arcjetCV
3
- Version: 1.1.0.dev3
2
+ Name: arcjetcv
3
+ Version: 1.1.0.dev5
4
4
  Summary: Package to process arcjet videos and segment the edge of the shock and of the sample
5
5
  Home-page: https://github.com/magnus-haw/arcjetCV
6
6
  Author: arcjetCV team
@@ -27,10 +27,12 @@ Requires-Dist: segmentation-models-pytorch
27
27
  Requires-Dist: torch
28
28
  Requires-Dist: torchvision
29
29
 
30
- [![Documentation Status](https://readthedocs.org/projects/arcjetcv/badge/?version=latest)](https://arcjetcv.readthedocs.io/en/latest/?badge=latest)
31
- [![Anaconda-Server Badge](https://anaconda.org/conda-forge/arcjetcv/badges/version.svg)](https://anaconda.org/conda-forge/arcjetcv)
30
+ [![GitHub Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://magnus-haw.github.io/arcjetCV/)
31
+ [![PyPI version](https://badge.fury.io/py/arcjetcv.svg)](https://pypi.org/project/arcjetcv/)
32
+ [![Downloads](https://pepy.tech/badge/arcjetcv)](https://pepy.tech/project/arcjetcv)
32
33
  [![tutorial](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/magnus-haw/arcjetCV/blob/main/tutorial.ipynb)
33
34
 
35
+
34
36
  -----
35
37
 
36
38
  <div align="center">
@@ -95,7 +97,7 @@ sudo pacman -S libxcb
95
97
  xcode-select --install
96
98
  ```
97
99
 
98
- To install **arcjetCV** for development puropse, follow these steps:
100
+ To install **arcjetCV** for development purposes, follow these steps:
99
101
 
100
102
  1. Install `git-lfs`:
101
103
 
@@ -1,7 +1,7 @@
1
- [![Documentation Status](https://readthedocs.org/projects/arcjetcv/badge/?version=latest)](https://arcjetcv.readthedocs.io/en/latest/?badge=latest)
2
- [![Anaconda-Server Badge](https://anaconda.org/conda-forge/arcjetcv/badges/version.svg)](https://anaconda.org/conda-forge/arcjetcv)
1
+ [![GitHub Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://magnus-haw.github.io/arcjetCV/)
2
+ [![PyPI version](https://badge.fury.io/py/arcjetcv.svg)](https://pypi.org/project/arcjetcv/)
3
3
  [![tutorial](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/magnus-haw/arcjetCV/blob/main/tutorial.ipynb)
4
-
4
+ [![Downloads](https://pepy.tech/badge/arcjetcv)](https://pepy.tech/project/arcjetcv)
5
5
  -----
6
6
 
7
7
  <div align="center">
@@ -63,7 +63,7 @@ sudo pacman -S libxcb
63
63
  - [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/)
64
64
  - [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html)
65
65
 
66
- To install **arcjetCV** for development puropse, follow these steps:
66
+ To install **arcjetCV** for development purposes, follow these steps:
67
67
 
68
68
  1. Install `git-lfs`:
69
69
 
@@ -0,0 +1,135 @@
1
+ [![GitHub Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://magnus-haw.github.io/arcjetCV/)
2
+ [![PyPI version](https://badge.fury.io/py/arcjetcv.svg)](https://pypi.org/project/arcjetcv/)
3
+ [![Downloads](https://pepy.tech/badge/arcjetcv)](https://pepy.tech/project/arcjetcv)
4
+ [![tutorial](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/magnus-haw/arcjetCV/blob/main/tutorial.ipynb)
5
+
6
+
7
+ -----
8
+
9
+ <div align="center">
10
+ <img src="https://raw.githubusercontent.com/magnus-haw/arcjetCV/main/arcjetCV/gui/logo/arcjetCV_logo_.png" alt="arcjetCV Logo" width="30%">
11
+
12
+ </div>
13
+
14
+ # arcjetCV
15
+
16
+ Package to process arcjet videos and segment the edge of the shock and of the sample.
17
+
18
+ ## Installation
19
+
20
+ ### PyPi Installation (Universal)
21
+
22
+ #### Prerequisites:
23
+ - Ensure you have **Python 3.8** or higher installed.
24
+
25
+ To install **arcjetCV** via **pip** from **PyPi**, run:
26
+
27
+ ```bash
28
+ pip install arcjetCV
29
+ ```
30
+
31
+ This will install **arcjetCV** along with its dependencies.
32
+
33
+ #### Note for macOS Users:
34
+ You might need to install Xcode Command Line Tools:
35
+
36
+ ```bash
37
+ xcode-select --install
38
+ ```
39
+
40
+ #### Note for Linux Users:
41
+
42
+ You may need to install **libxcb-cursor**. Use your package manager to install it:
43
+
44
+ For **Ubuntu/Debian**-based distributions:
45
+ ```bash
46
+ sudo apt-get install libxcb-cursor0
47
+ ```
48
+
49
+ For **Fedora**:
50
+ ```bash
51
+ sudo dnf install libxcb-cursor
52
+ ```
53
+
54
+ For **Arch Linux**:
55
+ ```bash
56
+ sudo pacman -S libxcb
57
+ ```
58
+
59
+ ### Developer Installation
60
+
61
+ #### Prerequisites:
62
+ - A valid **git** installation.
63
+ - **Miniconda** or **Anaconda** for environment and package management:
64
+ - [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/)
65
+ - [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html)
66
+ - For **macOS** users make sure the Xcode Command Line Tools are installed:
67
+ ```bash
68
+ xcode-select --install
69
+ ```
70
+
71
+ To install **arcjetCV** for development purposes, follow these steps:
72
+
73
+ 1. Install `git-lfs`:
74
+
75
+ Download and install it from [here](https://git-lfs.github.com/).
76
+
77
+ 2. Clone the repository and install the package:
78
+
79
+ ```bash
80
+ git clone https://github.com/magnus-haw/arcjetCV.git
81
+ cd arcjetCV
82
+ conda env create -f env/arcjetCV_env_[cpu/gpu].yml
83
+ conda activate arcjetcv
84
+ python -m pip install -e .
85
+ ```
86
+
87
+ The `-e` flag stands for 'editable' and means that any changes to the local source code will immediately affect the **arcjetCV** package and GUI.
88
+
89
+
90
+ ## How to Run
91
+
92
+ You can now launch the GUI by running:
93
+
94
+ ```bash
95
+ conda activate arcjetcv # (if using conda)
96
+ arcjetCV
97
+ ```
98
+
99
+ Alternatively, you can use **arcjetCV's Python API** inside a Python script, e.g., `test.py`:
100
+
101
+ ```python
102
+ import arcjetCV as arcv
103
+ video = arcv.Video("tests/arcjet_test.mp4")
104
+ ```
105
+
106
+ Run the script with:
107
+
108
+ ```bash
109
+ conda activate arcjetcv # (if using conda)
110
+ python test.py
111
+ ```
112
+
113
+
114
+
115
+ ## Citing
116
+
117
+ If you use arcjetCV in your research, please use the following BibTeX entry to cite [our paper](https://arxiv.org/abs/2404.11492):
118
+
119
+ ```BibTeX
120
+ @article{arcjetCV,
121
+ title={arcjetCV: an open-source software to analyze material ablation},
122
+ author={Quintart, Alexandre and Haw, Magnus and Semeraro, Federico},
123
+ journal={arXiv preprint arXiv:2404.11492},
124
+ year={2024}
125
+ }
126
+ ```
127
+
128
+ ## Legal / License
129
+ Copyright © 2024 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
130
+
131
+ Disclaimers
132
+
133
+ No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES IT "AS IS."
134
+
135
+ Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.