GitHub Docs PyPI version Downloads tutorial

arcjetCV Logo

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:

You might need to install Xcode Command Line Tools:

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

Developer Installation

Prerequisites:

  • A valid git installation.

  • Miniconda or Anaconda for environment and package management:

  • For macOS users make sure the Xcode Command Line Tools are installed:

xcode-select --install

To install arcjetCV for development purposes, 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 # (if using conda)
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 # (if using conda)
python test.py

Citing

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

@article{doi:10.2514/1.A36132,
author = {Quintart, Alexandre M. and Haw, Magnus A. and Semeraro, Federico},
title = {arcjetCV: Open-Source Software to Analyze Material Ablation},
journal = {Journal of Spacecraft and Rockets},
volume = {0},
number = {0},
pages = {1-10},
year = {0},
doi = {10.2514/1.A36132},
URL = {https://doi.org/10.2514/1.A36132},
eprint = {https://doi.org/10.2514/1.A36132}
}