arcjetCV 0.0.2__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 (38) hide show
  1. arcjetcv-0.0.2/LICENSE +259 -0
  2. arcjetcv-0.0.2/MANIFEST.in +2 -0
  3. arcjetcv-0.0.2/PKG-INFO +121 -0
  4. arcjetcv-0.0.2/README.md +103 -0
  5. arcjetcv-0.0.2/arcjetCV/__init__.py +20 -0
  6. arcjetcv-0.0.2/arcjetCV/gui/__init__.py +0 -0
  7. arcjetcv-0.0.2/arcjetCV/gui/arcjetCV_gui.py +849 -0
  8. arcjetcv-0.0.2/arcjetCV/gui/custom_classes.py +62 -0
  9. arcjetcv-0.0.2/arcjetCV/gui/logo/arcjetCV_logo_.png +0 -0
  10. arcjetcv-0.0.2/arcjetCV/gui/logo/arcjetCV_logo_white.png +0 -0
  11. arcjetcv-0.0.2/arcjetCV/gui/main.py +23 -0
  12. arcjetcv-0.0.2/arcjetCV/gui/main_window.py +1006 -0
  13. arcjetcv-0.0.2/arcjetCV/segmentation/__init__.py +0 -0
  14. arcjetcv-0.0.2/arcjetCV/segmentation/contour/__init__.py +32 -0
  15. arcjetcv-0.0.2/arcjetCV/segmentation/contour/cnn.py +49 -0
  16. arcjetcv-0.0.2/arcjetCV/segmentation/contour/contour.py +386 -0
  17. arcjetcv-0.0.2/arcjetCV/segmentation/time/__init__.py +0 -0
  18. arcjetcv-0.0.2/arcjetCV/segmentation/time/time-checkpoint.pt +0 -0
  19. arcjetcv-0.0.2/arcjetCV/segmentation/time/time_segmentation.py +120 -0
  20. arcjetcv-0.0.2/arcjetCV/utils/__init__.py +0 -0
  21. arcjetcv-0.0.2/arcjetCV/utils/logger.py +14 -0
  22. arcjetcv-0.0.2/arcjetCV/utils/output.py +124 -0
  23. arcjetcv-0.0.2/arcjetCV/utils/processor.py +423 -0
  24. arcjetcv-0.0.2/arcjetCV/utils/utils.py +158 -0
  25. arcjetcv-0.0.2/arcjetCV/utils/video.py +293 -0
  26. arcjetcv-0.0.2/arcjetCV.egg-info/PKG-INFO +121 -0
  27. arcjetcv-0.0.2/arcjetCV.egg-info/SOURCES.txt +36 -0
  28. arcjetcv-0.0.2/arcjetCV.egg-info/dependency_links.txt +1 -0
  29. arcjetcv-0.0.2/arcjetCV.egg-info/entry_points.txt +2 -0
  30. arcjetcv-0.0.2/arcjetCV.egg-info/top_level.txt +2 -0
  31. arcjetcv-0.0.2/setup.cfg +4 -0
  32. arcjetcv-0.0.2/setup.py +45 -0
  33. arcjetcv-0.0.2/tests/README.md +29 -0
  34. arcjetcv-0.0.2/tests/__init__.py +0 -0
  35. arcjetcv-0.0.2/tests/test_functions.py +118 -0
  36. arcjetcv-0.0.2/tests/test_gui.py +514 -0
  37. arcjetcv-0.0.2/tests/test_obj_models.py +112 -0
  38. arcjetcv-0.0.2/tests/test_segmentation.py +206 -0
arcjetcv-0.0.2/LICENSE ADDED
@@ -0,0 +1,259 @@
1
+ NASA OPEN SOURCE AGREEMENT VERSION 1.3
2
+ THIS OPEN SOURCE AGREEMENT (“AGREEMENT”) DEFINES THE RIGHTS OF USE,
3
+ REPRODUCTION, DISTRIBUTION, MODIFICATION AND REDISTRIBUTION OF CERTAIN COMPUTER
4
+ SOFTWARE ORIGINALLY RELEASED BY THE UNITED STATES GOVERNMENT AS REPRESENTED BY
5
+ THE GOVERNMENT AGENCY LISTED BELOW ("GOVERNMENT AGENCY"). THE UNITED STATES
6
+ GOVERNMENT, AS REPRESENTED BY GOVERNMENT AGENCY, IS AN INTENDED THIRD-PARTY
7
+ BENEFICIARY OF ALL SUBSEQUENT DISTRIBUTIONS OR REDISTRIBUTIONS OF THE SUBJECT
8
+ SOFTWARE. ANYONE WHO USES, REPRODUCES, DISTRIBUTES, MODIFIES OR REDISTRIBUTES
9
+ THE SUBJECT SOFTWARE, AS DEFINED HEREIN, OR ANY PART THEREOF, IS, BY THAT
10
+ ACTION, ACCEPTING IN FULL THE RESPONSIBILITIES AND OBLIGATIONS CONTAINED IN THIS
11
+ AGREEMENT.
12
+
13
+ Government Agency: NASA Ames Research Center
14
+ Government Agency Original Software Designation: NASA Ames Research Center
15
+ Government Agency Original Software Title: arcjetCV: computer vision application for time-resolved recession measurements from arc jet video files, ARC-18837-1
16
+ User Registration Requested. Please e-mail Government Agency Point of Contact
17
+ Government Agency Point of Contact for Original Software: Magnus Haw
18
+
19
+
20
+ 1. DEFINITIONS
21
+
22
+ A. “Contributor” means Government Agency, as the developer of the
23
+ Original Software, and any entity that makes a Modification.
24
+
25
+ B. “Covered Patents” mean patent claims licensable by a Contributor that
26
+ are necessarily infringed by the use or sale of its Modification alone or
27
+ when combined with the Subject Software.
28
+
29
+ C. “Display” means the showing of a copy of the Subject Software,
30
+ either directly or by means of an image, or any other device.
31
+
32
+ D. “Distribution” means conveyance or transfer of the Subject Software,
33
+ regardless of means, to another.
34
+
35
+ E. “Larger Work” means computer software that combines Subject
36
+ Software, or portions thereof, with software separate from the Subject
37
+ Software that is not governed by the terms of this Agreement.
38
+
39
+ F. “Modification” means any alteration of, including addition to or
40
+ deletion from, the substance or structure of either the Original
41
+ Software or Subject Software, and includes derivative works, as that
42
+ term is defined in the Copyright Statute, 17 USC 101. However, the
43
+ act of including Subject Software as part of a Larger Work does not in
44
+ and of itself constitute a Modification.
45
+
46
+ G. “Original Software” means the computer software first released under
47
+ this Agreement by Government Agency with Government Agency
48
+ designation NASA Ames Research Center and entitled arcjetCV: computer vision application for time-resolved recession measurements from arc jet video files, ARC-18837-1, including source code, object code and
49
+ accompanying documentation, if any.
50
+
51
+ H. “Recipient” means anyone who acquires the Subject Software under
52
+ this Agreement, including all Contributors.
53
+
54
+ I. “Redistribution” means Distribution of the Subject Software after a
55
+ Modification has been made.
56
+
57
+ J. “Reproduction” means the making of a counterpart, image or copy of
58
+ the Subject Software.
59
+
60
+ K. “Sale” means the exchange of the Subject Software for money or
61
+ equivalent value.
62
+
63
+ L. “Subject Software” means the Original Software, Modifications, or
64
+ any respective parts thereof.
65
+
66
+ M. “Use” means the application or employment of the Subject Software
67
+ for any purpose.
68
+
69
+ 2. GRANT OF RIGHTS
70
+
71
+ A. Under Non-Patent Rights: Subject to the terms and conditions of this
72
+ Agreement, each Contributor, with respect to its own contribution to
73
+ the Subject Software, hereby grants to each Recipient a non-exclusive,
74
+ world-wide, royalty-free license to engage in the following activities
75
+ pertaining to the Subject Software:
76
+
77
+ 1. Use
78
+ 2. Distribution
79
+ 3. Reproduction
80
+ 4. Modification
81
+ 5. Redistribution
82
+ 6. Display
83
+
84
+ B. Under Patent Rights: Subject to the terms and conditions of this
85
+ Agreement, each Contributor, with respect to its own contribution to
86
+ the Subject Software, hereby grants to each Recipient under Covered
87
+ Patents a non-exclusive, world-wide, royalty-free license to engage in
88
+ the following activities pertaining to the Subject Software:
89
+
90
+ 1. Use
91
+ 2. Distribution
92
+ 3. Reproduction
93
+ 4. Sale
94
+ 5. Offer for Sale
95
+
96
+ C. The rights granted under Paragraph B. also apply to the combination of
97
+ a Contributor’s Modification and the Subject Software if, at the time
98
+ the Modification is added by the Contributor, the addition of such
99
+ Modification causes the combination to be covered by the Covered
100
+ Patents. It does not apply to any other combinations that include a
101
+ Modification.
102
+
103
+ D. The rights granted in Paragraphs A. and B. allow the Recipient to
104
+ sublicense those same rights. Such sublicense must be under the same
105
+ terms and conditions of this Agreement.
106
+
107
+
108
+ 3. OBLIGATIONS OF RECIPIENT
109
+
110
+ A. Distribution or Redistribution of the Subject Software must be made
111
+ under this Agreement except for additions covered under paragraph
112
+ 3H.
113
+
114
+ 1. Whenever a Recipient distributes or redistributes the Subject
115
+ Software, a copy of this Agreement must be included with each
116
+ copy of the Subject Software; and
117
+
118
+ 2. If Recipient distributes or redistributes the Subject Software in
119
+ any form other than source code, Recipient must also make the
120
+ source code freely available, and must provide with each copy of
121
+ the Subject Software information on how to obtain the source
122
+ code in a reasonable manner on or through a medium
123
+ customarily used for software exchange.
124
+
125
+ B. Each Recipient must ensure that the following copyright notice
126
+ appears prominently in the Subject Software:
127
+
128
+ Copyright © 2024 United States Government as represented by the
129
+ Administrator of the National Aeronautics and Space Administration.
130
+ All Rights Reserved.
131
+
132
+ C. Each Contributor must characterize its alteration of the Subject
133
+ Software as a Modification and must identify itself as the originator of
134
+ its Modification in a manner that reasonably allows subsequent
135
+ Recipients to identify the originator of the Modification. In fulfillment
136
+ of these requirements, Contributor must include a file (e.g., a change
137
+ log file) that describes the alterations made and the date of the
138
+ alterations, identifies Contributor as originator of the alterations, and
139
+ consents to characterization of the alterations as a Modification, for
140
+ example, by including a statement that the Modification is derived,
141
+ directly or indirectly, from Original Software provided by Government
142
+ Agency. Once consent is granted, it may not thereafter be revoked.
143
+
144
+ D. A Contributor may add its own copyright notice to the Subject
145
+ Software. Once a copyright notice has been added to the Subject
146
+ Software, a Recipient may not remove it without the express
147
+ permission of the Contributor who added the notice.
148
+
149
+ E. A Recipient may not make any representation in the Subject Software
150
+ or in any promotional, advertising or other material that may be
151
+ construed as an endorsement by Government Agency or by any prior
152
+ Recipient of any product or service provided by Recipient, or that may
153
+ seek to obtain commercial advantage by the fact of Government
154
+ Agency's or a prior Recipient’s participation in this Agreement.
155
+
156
+ F. In an effort to track usage and maintain accurate records of the Subject
157
+ Software, each Recipient, upon receipt of the Subject Software, is
158
+ requested to provide Government Agency, by e-mail to the
159
+ Government Agency Point of Contact listed in clause 5.F., the
160
+ following information: name and email. Recipient’s name and
161
+ personal information shall be used for statistical purposes only. Once a
162
+ Recipient makes a Modification available, it is requested that the
163
+ Recipient inform Government Agency, by e-mail to the Government
164
+ Agency Point of Contact listed in clause 5.F., how to access the
165
+ Modification.
166
+
167
+ G. Each Contributor represents that that its Modification is believed to be
168
+ Contributor’s original creation and does not violate any existing
169
+ agreements, regulations, statutes or rules, and further that Contributor
170
+ has sufficient rights to grant the rights conveyed by this Agreement.
171
+
172
+ H. A Recipient may choose to offer, and to charge a fee for, warranty,
173
+ support, indemnity and/or liability obligations to one or more other
174
+ Recipients of the Subject Software. A Recipient may do so, however,
175
+ only on its own behalf and not on behalf of Government Agency or
176
+ any other Recipient. Such a Recipient must make it absolutely clear
177
+ that any such warranty, support, indemnity and/or liability obligation
178
+ is offered by that Recipient alone. Further, such Recipient agrees to
179
+ indemnify Government Agency and every other Recipient for any
180
+ liability incurred by them as a result of warranty, support, indemnity
181
+ and/or liability offered by such Recipient.
182
+
183
+ I. A Recipient may create a Larger Work by combining Subject Software
184
+ with separate software not governed by the terms of this agreement
185
+ and distribute the Larger Work as a single product. In such case, the
186
+ Recipient must make sure Subject Software, or portions thereof,
187
+ included in the Larger Work is subject to this Agreement.
188
+
189
+ J. Notwithstanding any provisions contained herein, Recipient is hereby
190
+ put on notice that export of any goods or technical data from the
191
+ United States may require some form of export license from the U.S.
192
+ Government. Failure to obtain necessary export licenses may result in
193
+ criminal liability under U.S. laws. Government Agency neither
194
+ represents that a license shall not be required nor that, if required, it
195
+ shall be issued. Nothing granted herein provides any such export
196
+ license.
197
+
198
+
199
+ 4.DISCLAIMER OF WARRANTIES AND LIABILITIES; WAIVER AND INDEMNIFICATION
200
+
201
+ A. No Warranty: THE SUBJECT SOFTWARE IS PROVIDED “AS IS” WITHOUT ANY WARRANTY OF
202
+ ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED
203
+ TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY
204
+ IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
205
+ FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR
206
+ FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE
207
+ SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER, CONSTITUTE AN
208
+ ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT OF ANY RESULTS,
209
+ RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY OTHER APPLICATIONS
210
+ RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER, GOVERNMENT AGENCY DISCLAIMS
211
+ ALL WARRANTIES AND LIABILITIES REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE
212
+ ORIGINAL SOFTWARE, AND DISTRIBUTES IT “AS IS.”
213
+
214
+ B. Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST
215
+ THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY
216
+ PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN ANY
217
+ LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE,
218
+ INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE
219
+ OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED
220
+ STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY PRIOR
221
+ RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY FOR ANY SUCH
222
+ MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS AGREEMENT.
223
+
224
+
225
+ 5. GENERAL TERMS
226
+
227
+ A. Termination: This Agreement and the rights granted hereunder will
228
+ terminate automatically if a Recipient fails to comply with these terms
229
+ and conditions, and fails to cure such noncompliance within thirty (30)
230
+ days of becoming aware of such noncompliance. Upon termination, a
231
+ Recipient agrees to immediately cease use and distribution of the
232
+ Subject Software. All sublicenses to the Subject Software properly
233
+ granted by the breaching Recipient shall survive any such termination
234
+ of this Agreement.
235
+
236
+ B. Severability: If any provision of this Agreement is invalid or
237
+ unenforceable under applicable law, it shall not affect the validity or
238
+ enforceability of the remainder of the terms of this Agreement.
239
+
240
+ C. Applicable Law: This Agreement shall be subject to United States
241
+ federal law only for all purposes, including, but not limited to,
242
+ determining the validity of this Agreement, the meaning of its
243
+ provisions and the rights, obligations and remedies of the parties.
244
+
245
+ D. Entire Understanding: This Agreement constitutes the entire
246
+ understanding and agreement of the parties relating to release of the
247
+ Subject Software and may not be superseded, modified or amended
248
+ except by further written agreement duly executed by the parties.
249
+
250
+ E. Binding Authority: By accepting and using the Subject Software
251
+ under this Agreement, a Recipient affirms its authority to bind the
252
+ Recipient to all terms and conditions of this Agreement and that that
253
+ Recipient hereby agrees to all terms and conditions herein.
254
+
255
+ F. Point of Contact: Any Recipient contact with Government Agency is
256
+ to be directed to the designated representative as follows:
257
+
258
+ Magnus Haw
259
+ magnus.haw@nasa.gov
@@ -0,0 +1,2 @@
1
+ exclude arcjetCV/segmentation/contour/Unet-xception_25_original.pt
2
+ exclude arcjetCV/segmentation/contour/Unet-xception-last-checkpoint.pt
@@ -0,0 +1,121 @@
1
+ Metadata-Version: 2.1
2
+ Name: arcjetCV
3
+ Version: 0.0.2
4
+ Summary: A package to compute material properties from micro-CT data.
5
+ Home-page: https://github.com/magnus-haw/arcjetCV
6
+ Author: arcjetCV team
7
+ Project-URL: Bug Tracker, https://github.com/magnus-haw/arcjetCV/issues
8
+ Platform: Linux
9
+ Platform: Mac
10
+ Platform: Windows
11
+ Classifier: Development Status :: 5 - Production/Stable
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Topic :: Scientific/Engineering
15
+ Classifier: Topic :: Scientific/Engineering :: Physics
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+
19
+ [![Documentation Status](https://readthedocs.org/projects/arcjetcv/badge/?version=latest)](https://arcjetcv.readthedocs.io/en/latest/?badge=latest)
20
+ [![Anaconda-Server Badge](https://anaconda.org/conda-forge/arcjetcv/badges/version.svg)](https://anaconda.org/conda-forge/arcjetcv)
21
+ [![tutorial](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/magnus-haw/arcjetCV/blob/main/tutorial.ipynb)
22
+
23
+ -----
24
+
25
+ <div align="center">
26
+ <img src="https://github.com/magnus-haw/arcjetCV/blob/main/arcjetCV/gui/logo/arcjetCV_logo_.png" alt="arcjetCV Logo" width="30%">
27
+ </div>
28
+
29
+ # arcjetCV
30
+
31
+ Package to process arcjet videos and segment the edge of the shock and of the sample.
32
+
33
+ ![arcjetCV Functionality](https://github.com/magnus-haw/arcjetCV/blob/main/docs/source/arcjet_video.gif)
34
+
35
+ ## Installation
36
+
37
+ ### Prerequisites
38
+ The installation of the arcjetCV GUI and python package require a valid git installation, installation of the git-lfs [(git large file storage)](https://git-lfs.github.com/) add-on and a
39
+ [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/) or
40
+ [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html) installation.
41
+
42
+ ### Unix Users
43
+
44
+ The software can be installed by running:
45
+
46
+ ```bash
47
+ conda create --name arcjetcv conda-forge::arcjetcv
48
+ ```
49
+ #### Note for macOS Users:
50
+
51
+
52
+ Please ensure that you have the Xcode Command Line Tools installed:
53
+
54
+ ```bash
55
+ xcode-select --install
56
+ ```
57
+
58
+ ### Windows Users and Developers
59
+
60
+ For local development of arcjetCV and for Windows users, these are the recommended installation steps:
61
+
62
+ 1. **Install `git lfs` (Git Large File Storage):**
63
+
64
+ You can download and install it from [here](https://git-lfs.github.com/).
65
+
66
+ 2. **Clone the repository and install the package:**
67
+
68
+ ```bash
69
+ git clone https://github.com/magnus-haw/arcjetCV.git
70
+ cd arcjetCV
71
+ conda env create -f env/arcjetCV_env_[cpu/gpu].yml
72
+ conda activate arcjetCV
73
+ python -m pip install -e .
74
+ ```
75
+
76
+ The -e flag stands for 'editable' and it means that any change to the local source code will have immediate effect on the arcjetCV python package and GUI.
77
+
78
+ ## How to Run
79
+
80
+ You can now launch the GUI by running:
81
+
82
+ ```bash
83
+ conda activate arcjetCV
84
+ arcjetCV
85
+ ```
86
+
87
+ or you can import arcjetCV's python API inside a python script, e.g. test.py:
88
+
89
+ ```python
90
+ import arcjetCV as arcv
91
+ video = arcv.Video("tests/arcjet_test.mp4")
92
+ ```
93
+
94
+ and then run it as:
95
+
96
+ ```bash
97
+ conda activate arcjetCV
98
+ python test.py
99
+ ```
100
+
101
+ ## Citing
102
+
103
+ If you use arcjetCV in your research, please use the following BibTeX entry to cite [our paper](https://arxiv.org/abs/2404.11492):
104
+
105
+ ```BibTeX
106
+ @article{arcjetCV,
107
+ title={arcjetCV: an open-source software to analyze material ablation},
108
+ author={Quintart, Alexandre and Haw, Magnus and Semeraro, Federico},
109
+ journal={arXiv preprint arXiv:2404.11492},
110
+ year={2024}
111
+ }
112
+ ```
113
+
114
+ ## Legal / License
115
+ Copyright © 2024 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
116
+
117
+ Disclaimers
118
+
119
+ 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."
120
+
121
+ 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.
@@ -0,0 +1,103 @@
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)
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
+
5
+ -----
6
+
7
+ <div align="center">
8
+ <img src="https://github.com/magnus-haw/arcjetCV/blob/main/arcjetCV/gui/logo/arcjetCV_logo_.png" alt="arcjetCV Logo" width="30%">
9
+ </div>
10
+
11
+ # arcjetCV
12
+
13
+ Package to process arcjet videos and segment the edge of the shock and of the sample.
14
+
15
+ ![arcjetCV Functionality](https://github.com/magnus-haw/arcjetCV/blob/main/docs/source/arcjet_video.gif)
16
+
17
+ ## Installation
18
+
19
+ ### Prerequisites
20
+ The installation of the arcjetCV GUI and python package require a valid git installation, installation of the git-lfs [(git large file storage)](https://git-lfs.github.com/) add-on and a
21
+ [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/) or
22
+ [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html) installation.
23
+
24
+ ### Unix Users
25
+
26
+ The software can be installed by running:
27
+
28
+ ```bash
29
+ conda create --name arcjetcv conda-forge::arcjetcv
30
+ ```
31
+ #### Note for macOS Users:
32
+
33
+
34
+ Please ensure that you have the Xcode Command Line Tools installed:
35
+
36
+ ```bash
37
+ xcode-select --install
38
+ ```
39
+
40
+ ### Windows Users and Developers
41
+
42
+ For local development of arcjetCV and for Windows users, these are the recommended installation steps:
43
+
44
+ 1. **Install `git lfs` (Git Large File Storage):**
45
+
46
+ You can download and install it from [here](https://git-lfs.github.com/).
47
+
48
+ 2. **Clone the repository and install the package:**
49
+
50
+ ```bash
51
+ git clone https://github.com/magnus-haw/arcjetCV.git
52
+ cd arcjetCV
53
+ conda env create -f env/arcjetCV_env_[cpu/gpu].yml
54
+ conda activate arcjetCV
55
+ python -m pip install -e .
56
+ ```
57
+
58
+ The -e flag stands for 'editable' and it means that any change to the local source code will have immediate effect on the arcjetCV python package and GUI.
59
+
60
+ ## How to Run
61
+
62
+ You can now launch the GUI by running:
63
+
64
+ ```bash
65
+ conda activate arcjetCV
66
+ arcjetCV
67
+ ```
68
+
69
+ or you can import arcjetCV's python API inside a python script, e.g. test.py:
70
+
71
+ ```python
72
+ import arcjetCV as arcv
73
+ video = arcv.Video("tests/arcjet_test.mp4")
74
+ ```
75
+
76
+ and then run it as:
77
+
78
+ ```bash
79
+ conda activate arcjetCV
80
+ python test.py
81
+ ```
82
+
83
+ ## Citing
84
+
85
+ If you use arcjetCV in your research, please use the following BibTeX entry to cite [our paper](https://arxiv.org/abs/2404.11492):
86
+
87
+ ```BibTeX
88
+ @article{arcjetCV,
89
+ title={arcjetCV: an open-source software to analyze material ablation},
90
+ author={Quintart, Alexandre and Haw, Magnus and Semeraro, Federico},
91
+ journal={arXiv preprint arXiv:2404.11492},
92
+ year={2024}
93
+ }
94
+ ```
95
+
96
+ ## Legal / License
97
+ Copyright © 2024 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
98
+
99
+ Disclaimers
100
+
101
+ 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."
102
+
103
+ 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.
@@ -0,0 +1,20 @@
1
+ """Copyright © 2024 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
2
+ Disclaimers
3
+ 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."
4
+ 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.
5
+
6
+ Root directory for the arcjetCV package.
7
+ """
8
+
9
+ # Note: only this version has to be bumped for the whole project
10
+ # to publish new version: (pre-requisite: conda install conda-forge::gh)
11
+ # - bump version below
12
+ # - git add -A
13
+ # - git commit -m 'Version bumped'
14
+ # - git push origin main
15
+ # - git tag -a v$(python setup.py --version) -m 'INPUT DESCRIPTION'
16
+ # - gh release create v$(python setup.py --version) --target main
17
+ __version__ = "0.0.2"
18
+
19
+ from arcjetCV.utils.video import Video, VideoMeta
20
+ from arcjetCV.utils.processor import ArcjetProcessor
File without changes