arcjetCV 0.0.5.dev1

Package to process arcjet videos and segment the edge of the shock and of the sample

---

arcjetCV

Package to process arcjet videos and segment the edge of the shock and of the sample.

Installation

PyPi Installation (Universal)

Prerequisites:

• Ensure you have Python 3.8 or higher installed.

To install arcjetCV via pip from PyPi, run:

pip install arcjetCV

This will install arcjetCV along with its dependencies.

Note for macOS Users:

Ensure that you have the Xcode Command Line Tools installed before running the installation command:

xcode-select --install

Note for Linux Users:

You may need to install libxcb-cursor. Use your package manager to install it:

For Ubuntu/Debian-based distributions:

sudo apt-get install libxcb-cursor0

For Fedora:

sudo dnf install libxcb-cursor

For Arch Linux:

sudo pacman -S libxcb

---

Conda Installation

Prerequisites:

• A valid git installation.
• Installation of git-lfs (Git Large File Storage) for handling large files.
• Miniconda or Anaconda for environment and package management:
  • Miniconda
  • Anaconda

For users who prefer conda for managing environments, follow these steps:

1. Create a new conda environment and install arcjetCV:

conda create --name arcjetcv conda-forge::arcjetcv
conda activate arcjetcv

This will install arcjetCV along with all its dependencies in an isolated environment.

Note for macOS Users:

Make sure the Xcode Command Line Tools are installed:

xcode-select --install

---

Windows Users and Developers

Prerequisites:

• Git LFS (Git Large File Storage) for handling large files.
• Miniconda or Anaconda for environment and package management.

For Windows users or for local development of arcjetCV, follow these steps:

1. Install git-lfs:

   Download and install it from here.

2. Clone the repository and install the package:

git clone https://github.com/magnus-haw/arcjetCV.git
cd arcjetCV
conda env create -f env/arcjetCV_env_[cpu/gpu].yml
conda activate arcjetcv
python -m pip install -e .

The -e flag stands for 'editable' and means that any changes to the local source code will immediately affect the arcjetCV package and GUI.

---

How to Run

You can now launch the GUI by running:

conda activate arcjetcv
arcjetCV

Alternatively, you can use arcjetCV's Python API inside a Python script, e.g., test.py:

import arcjetCV as arcv
video = arcv.Video("tests/arcjet_test.mp4")

Run the script with:

conda activate arcjetcv
python test.py

---

Citing

If you use arcjetCV in your research, please use the following BibTeX entry to cite our paper:

@article{arcjetCV,
  title={arcjetCV: an open-source software to analyze material ablation},
  author={Quintart, Alexandre and Haw, Magnus and Semeraro, Federico},
  journal={arXiv preprint arXiv:2404.11492},
  year={2024}
}

Legal / License

Copyright © 2024 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.

Disclaimers

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."

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.