arcjetCV 0.0.5__tar.gz → 0.0.5.dev1__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 (37) hide show
  1. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/PKG-INFO +78 -21
  2. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/README.md +77 -20
  3. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV.egg-info/PKG-INFO +78 -21
  4. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/setup.py +1 -1
  5. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/LICENSE +0 -0
  6. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/__init__.py +0 -0
  7. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/gui/__init__.py +0 -0
  8. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/gui/arcjetCV_gui.py +0 -0
  9. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/gui/custom_classes.py +0 -0
  10. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/gui/logo/arcjetCV_logo_.png +0 -0
  11. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/gui/logo/arcjetCV_logo_white.png +0 -0
  12. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/gui/main.py +0 -0
  13. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/gui/main_window.py +0 -0
  14. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/segmentation/__init__.py +0 -0
  15. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/segmentation/contour/__init__.py +0 -0
  16. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/segmentation/contour/cnn.py +0 -0
  17. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/segmentation/contour/contour.py +0 -0
  18. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/segmentation/time/__init__.py +0 -0
  19. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/segmentation/time/time_segmentation.py +0 -0
  20. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/utils/__init__.py +0 -0
  21. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/utils/logger.py +0 -0
  22. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/utils/output.py +0 -0
  23. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/utils/processor.py +0 -0
  24. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/utils/utils.py +0 -0
  25. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV/utils/video.py +0 -0
  26. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV.egg-info/SOURCES.txt +0 -0
  27. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV.egg-info/dependency_links.txt +0 -0
  28. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV.egg-info/entry_points.txt +0 -0
  29. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV.egg-info/requires.txt +0 -0
  30. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/arcjetCV.egg-info/top_level.txt +0 -0
  31. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/setup.cfg +0 -0
  32. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/tests/README.md +0 -0
  33. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/tests/__init__.py +0 -0
  34. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/tests/test_functions.py +0 -0
  35. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/tests/test_gui.py +0 -0
  36. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/tests/test_obj_models.py +0 -0
  37. {arcjetcv-0.0.5 → arcjetcv-0.0.5.dev1}/tests/test_segmentation.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: arcjetCV
3
- Version: 0.0.5
3
+ Version: 0.0.5.dev1
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
@@ -42,73 +42,130 @@ Package to process arcjet videos and segment the edge of the shock and of the sa
42
42
 
43
43
  ![arcjetCV Functionality](https://i.imgur.com/YOUR_IMAGE_ID.gif)
44
44
 
45
-
46
45
  ## Installation
47
46
 
48
- ### Prerequisites
49
- 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
50
- [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/) or
51
- [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html) installation.
47
+ ### PyPi Installation (Universal)
52
48
 
53
- ### Unix Users
49
+ #### Prerequisites:
50
+ - Ensure you have **Python 3.8** or higher installed.
54
51
 
55
- The software can be installed by running:
52
+ To install **arcjetCV** via **pip** from **PyPi**, run:
56
53
 
57
54
  ```bash
58
- conda create --name arcjetcv conda-forge::arcjetcv
55
+ pip install arcjetCV
59
56
  ```
57
+
58
+ This will install **arcjetCV** along with its dependencies.
59
+
60
60
  #### Note for macOS Users:
61
+ Ensure that you have the Xcode Command Line Tools installed before running the installation command:
62
+
63
+ ```bash
64
+ xcode-select --install
65
+ ```
66
+
67
+ #### Note for Linux Users:
68
+
69
+ You may need to install **libxcb-cursor**. Use your package manager to install it:
70
+
71
+ For **Ubuntu/Debian**-based distributions:
72
+ ```bash
73
+ sudo apt-get install libxcb-cursor0
74
+ ```
75
+
76
+ For **Fedora**:
77
+ ```bash
78
+ sudo dnf install libxcb-cursor
79
+ ```
80
+
81
+ For **Arch Linux**:
82
+ ```bash
83
+ sudo pacman -S libxcb
84
+ ```
85
+
86
+ ---
87
+
88
+ ### Conda Installation
89
+
90
+ #### Prerequisites:
91
+ - A valid **git** installation.
92
+ - Installation of **git-lfs** [(Git Large File Storage)](https://git-lfs.github.com/) for handling large files.
93
+ - **Miniconda** or **Anaconda** for environment and package management:
94
+ - [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/)
95
+ - [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html)
61
96
 
97
+ For users who prefer **conda** for managing environments, follow these steps:
62
98
 
63
- Please ensure that you have the Xcode Command Line Tools installed:
99
+ 1. Create a new conda environment and install arcjetCV:
100
+
101
+ ```bash
102
+ conda create --name arcjetcv conda-forge::arcjetcv
103
+ conda activate arcjetcv
104
+ ```
105
+
106
+ This will install **arcjetCV** along with all its dependencies in an isolated environment.
107
+
108
+ #### Note for macOS Users:
109
+ Make sure the Xcode Command Line Tools are installed:
64
110
 
65
111
  ```bash
66
112
  xcode-select --install
67
113
  ```
68
114
 
115
+ ---
116
+
69
117
  ### Windows Users and Developers
70
118
 
71
- For local development of arcjetCV and for Windows users, these are the recommended installation steps:
119
+ #### Prerequisites:
120
+ - **Git LFS** [(Git Large File Storage)](https://git-lfs.github.com/) for handling large files.
121
+ - **Miniconda** or **Anaconda** for environment and package management.
72
122
 
73
- 1. **Install `git lfs` (Git Large File Storage):**
123
+ For Windows users or for local development of **arcjetCV**, follow these steps:
74
124
 
75
- You can download and install it from [here](https://git-lfs.github.com/).
125
+ 1. Install `git-lfs`:
76
126
 
77
- 2. **Clone the repository and install the package:**
127
+ Download and install it from [here](https://git-lfs.github.com/).
128
+
129
+ 2. Clone the repository and install the package:
78
130
 
79
131
  ```bash
80
132
  git clone https://github.com/magnus-haw/arcjetCV.git
81
133
  cd arcjetCV
82
134
  conda env create -f env/arcjetCV_env_[cpu/gpu].yml
83
- conda activate arcjetCV
84
- python -m pip install -e .
135
+ conda activate arcjetcv
136
+ python -m pip install -e .
85
137
  ```
86
138
 
87
- 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.
139
+ The `-e` flag stands for 'editable' and means that any changes to the local source code will immediately affect the **arcjetCV** package and GUI.
140
+
141
+ ---
88
142
 
89
143
  ## How to Run
90
144
 
91
145
  You can now launch the GUI by running:
92
146
 
93
147
  ```bash
94
- conda activate arcjetCV
148
+ conda activate arcjetcv
95
149
  arcjetCV
96
150
  ```
97
151
 
98
- or you can import arcjetCV's python API inside a python script, e.g. test.py:
152
+ Alternatively, you can use **arcjetCV's Python API** inside a Python script, e.g., `test.py`:
99
153
 
100
154
  ```python
101
155
  import arcjetCV as arcv
102
156
  video = arcv.Video("tests/arcjet_test.mp4")
103
157
  ```
104
158
 
105
- and then run it as:
159
+ Run the script with:
106
160
 
107
161
  ```bash
108
- conda activate arcjetCV
162
+ conda activate arcjetcv
109
163
  python test.py
110
164
  ```
111
165
 
166
+ ---
167
+
168
+
112
169
  ## Citing
113
170
 
114
171
  If you use arcjetCV in your research, please use the following BibTeX entry to cite [our paper](https://arxiv.org/abs/2404.11492):
@@ -15,73 +15,130 @@ Package to process arcjet videos and segment the edge of the shock and of the sa
15
15
 
16
16
  ![arcjetCV Functionality](https://i.imgur.com/YOUR_IMAGE_ID.gif)
17
17
 
18
-
19
18
  ## Installation
20
19
 
21
- ### Prerequisites
22
- 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
23
- [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/) or
24
- [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html) installation.
20
+ ### PyPi Installation (Universal)
25
21
 
26
- ### Unix Users
22
+ #### Prerequisites:
23
+ - Ensure you have **Python 3.8** or higher installed.
27
24
 
28
- The software can be installed by running:
25
+ To install **arcjetCV** via **pip** from **PyPi**, run:
29
26
 
30
27
  ```bash
31
- conda create --name arcjetcv conda-forge::arcjetcv
28
+ pip install arcjetCV
32
29
  ```
30
+
31
+ This will install **arcjetCV** along with its dependencies.
32
+
33
33
  #### Note for macOS Users:
34
+ Ensure that you have the Xcode Command Line Tools installed before running the installation command:
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
+ ---
60
+
61
+ ### Conda Installation
62
+
63
+ #### Prerequisites:
64
+ - A valid **git** installation.
65
+ - Installation of **git-lfs** [(Git Large File Storage)](https://git-lfs.github.com/) for handling large files.
66
+ - **Miniconda** or **Anaconda** for environment and package management:
67
+ - [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/)
68
+ - [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html)
34
69
 
70
+ For users who prefer **conda** for managing environments, follow these steps:
35
71
 
36
- Please ensure that you have the Xcode Command Line Tools installed:
72
+ 1. Create a new conda environment and install arcjetCV:
73
+
74
+ ```bash
75
+ conda create --name arcjetcv conda-forge::arcjetcv
76
+ conda activate arcjetcv
77
+ ```
78
+
79
+ This will install **arcjetCV** along with all its dependencies in an isolated environment.
80
+
81
+ #### Note for macOS Users:
82
+ Make sure the Xcode Command Line Tools are installed:
37
83
 
38
84
  ```bash
39
85
  xcode-select --install
40
86
  ```
41
87
 
88
+ ---
89
+
42
90
  ### Windows Users and Developers
43
91
 
44
- For local development of arcjetCV and for Windows users, these are the recommended installation steps:
92
+ #### Prerequisites:
93
+ - **Git LFS** [(Git Large File Storage)](https://git-lfs.github.com/) for handling large files.
94
+ - **Miniconda** or **Anaconda** for environment and package management.
45
95
 
46
- 1. **Install `git lfs` (Git Large File Storage):**
96
+ For Windows users or for local development of **arcjetCV**, follow these steps:
47
97
 
48
- You can download and install it from [here](https://git-lfs.github.com/).
98
+ 1. Install `git-lfs`:
49
99
 
50
- 2. **Clone the repository and install the package:**
100
+ Download and install it from [here](https://git-lfs.github.com/).
101
+
102
+ 2. Clone the repository and install the package:
51
103
 
52
104
  ```bash
53
105
  git clone https://github.com/magnus-haw/arcjetCV.git
54
106
  cd arcjetCV
55
107
  conda env create -f env/arcjetCV_env_[cpu/gpu].yml
56
- conda activate arcjetCV
57
- python -m pip install -e .
108
+ conda activate arcjetcv
109
+ python -m pip install -e .
58
110
  ```
59
111
 
60
- 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.
112
+ The `-e` flag stands for 'editable' and means that any changes to the local source code will immediately affect the **arcjetCV** package and GUI.
113
+
114
+ ---
61
115
 
62
116
  ## How to Run
63
117
 
64
118
  You can now launch the GUI by running:
65
119
 
66
120
  ```bash
67
- conda activate arcjetCV
121
+ conda activate arcjetcv
68
122
  arcjetCV
69
123
  ```
70
124
 
71
- or you can import arcjetCV's python API inside a python script, e.g. test.py:
125
+ Alternatively, you can use **arcjetCV's Python API** inside a Python script, e.g., `test.py`:
72
126
 
73
127
  ```python
74
128
  import arcjetCV as arcv
75
129
  video = arcv.Video("tests/arcjet_test.mp4")
76
130
  ```
77
131
 
78
- and then run it as:
132
+ Run the script with:
79
133
 
80
134
  ```bash
81
- conda activate arcjetCV
135
+ conda activate arcjetcv
82
136
  python test.py
83
137
  ```
84
138
 
139
+ ---
140
+
141
+
85
142
  ## Citing
86
143
 
87
144
  If you use arcjetCV in your research, please use the following BibTeX entry to cite [our paper](https://arxiv.org/abs/2404.11492):
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: arcjetCV
3
- Version: 0.0.5
3
+ Version: 0.0.5.dev1
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
@@ -42,73 +42,130 @@ Package to process arcjet videos and segment the edge of the shock and of the sa
42
42
 
43
43
  ![arcjetCV Functionality](https://i.imgur.com/YOUR_IMAGE_ID.gif)
44
44
 
45
-
46
45
  ## Installation
47
46
 
48
- ### Prerequisites
49
- 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
50
- [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/) or
51
- [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html) installation.
47
+ ### PyPi Installation (Universal)
52
48
 
53
- ### Unix Users
49
+ #### Prerequisites:
50
+ - Ensure you have **Python 3.8** or higher installed.
54
51
 
55
- The software can be installed by running:
52
+ To install **arcjetCV** via **pip** from **PyPi**, run:
56
53
 
57
54
  ```bash
58
- conda create --name arcjetcv conda-forge::arcjetcv
55
+ pip install arcjetCV
59
56
  ```
57
+
58
+ This will install **arcjetCV** along with its dependencies.
59
+
60
60
  #### Note for macOS Users:
61
+ Ensure that you have the Xcode Command Line Tools installed before running the installation command:
62
+
63
+ ```bash
64
+ xcode-select --install
65
+ ```
66
+
67
+ #### Note for Linux Users:
68
+
69
+ You may need to install **libxcb-cursor**. Use your package manager to install it:
70
+
71
+ For **Ubuntu/Debian**-based distributions:
72
+ ```bash
73
+ sudo apt-get install libxcb-cursor0
74
+ ```
75
+
76
+ For **Fedora**:
77
+ ```bash
78
+ sudo dnf install libxcb-cursor
79
+ ```
80
+
81
+ For **Arch Linux**:
82
+ ```bash
83
+ sudo pacman -S libxcb
84
+ ```
85
+
86
+ ---
87
+
88
+ ### Conda Installation
89
+
90
+ #### Prerequisites:
91
+ - A valid **git** installation.
92
+ - Installation of **git-lfs** [(Git Large File Storage)](https://git-lfs.github.com/) for handling large files.
93
+ - **Miniconda** or **Anaconda** for environment and package management:
94
+ - [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/)
95
+ - [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html)
61
96
 
97
+ For users who prefer **conda** for managing environments, follow these steps:
62
98
 
63
- Please ensure that you have the Xcode Command Line Tools installed:
99
+ 1. Create a new conda environment and install arcjetCV:
100
+
101
+ ```bash
102
+ conda create --name arcjetcv conda-forge::arcjetcv
103
+ conda activate arcjetcv
104
+ ```
105
+
106
+ This will install **arcjetCV** along with all its dependencies in an isolated environment.
107
+
108
+ #### Note for macOS Users:
109
+ Make sure the Xcode Command Line Tools are installed:
64
110
 
65
111
  ```bash
66
112
  xcode-select --install
67
113
  ```
68
114
 
115
+ ---
116
+
69
117
  ### Windows Users and Developers
70
118
 
71
- For local development of arcjetCV and for Windows users, these are the recommended installation steps:
119
+ #### Prerequisites:
120
+ - **Git LFS** [(Git Large File Storage)](https://git-lfs.github.com/) for handling large files.
121
+ - **Miniconda** or **Anaconda** for environment and package management.
72
122
 
73
- 1. **Install `git lfs` (Git Large File Storage):**
123
+ For Windows users or for local development of **arcjetCV**, follow these steps:
74
124
 
75
- You can download and install it from [here](https://git-lfs.github.com/).
125
+ 1. Install `git-lfs`:
76
126
 
77
- 2. **Clone the repository and install the package:**
127
+ Download and install it from [here](https://git-lfs.github.com/).
128
+
129
+ 2. Clone the repository and install the package:
78
130
 
79
131
  ```bash
80
132
  git clone https://github.com/magnus-haw/arcjetCV.git
81
133
  cd arcjetCV
82
134
  conda env create -f env/arcjetCV_env_[cpu/gpu].yml
83
- conda activate arcjetCV
84
- python -m pip install -e .
135
+ conda activate arcjetcv
136
+ python -m pip install -e .
85
137
  ```
86
138
 
87
- 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.
139
+ The `-e` flag stands for 'editable' and means that any changes to the local source code will immediately affect the **arcjetCV** package and GUI.
140
+
141
+ ---
88
142
 
89
143
  ## How to Run
90
144
 
91
145
  You can now launch the GUI by running:
92
146
 
93
147
  ```bash
94
- conda activate arcjetCV
148
+ conda activate arcjetcv
95
149
  arcjetCV
96
150
  ```
97
151
 
98
- or you can import arcjetCV's python API inside a python script, e.g. test.py:
152
+ Alternatively, you can use **arcjetCV's Python API** inside a Python script, e.g., `test.py`:
99
153
 
100
154
  ```python
101
155
  import arcjetCV as arcv
102
156
  video = arcv.Video("tests/arcjet_test.mp4")
103
157
  ```
104
158
 
105
- and then run it as:
159
+ Run the script with:
106
160
 
107
161
  ```bash
108
- conda activate arcjetCV
162
+ conda activate arcjetcv
109
163
  python test.py
110
164
  ```
111
165
 
166
+ ---
167
+
168
+
112
169
  ## Citing
113
170
 
114
171
  If you use arcjetCV in your research, please use the following BibTeX entry to cite [our paper](https://arxiv.org/abs/2404.11492):
@@ -29,7 +29,7 @@ check_linux_dependencies()
29
29
  # Define the setup configuration
30
30
  setup(
31
31
  name="arcjetCV",
32
- version="0.0.5", # Set the version directly here
32
+ version="0.0.5.dev1", # Set the version directly here
33
33
  author="arcjetCV team",
34
34
  description="Package to process arcjet videos and segment the edge of the shock and of the sample",
35
35
  long_description=long_description,
File without changes
File without changes
File without changes