Skip to main content

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

Project description

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}
}

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arcjetcv-1.1.4.dev0.tar.gz (455.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

arcjetcv-1.1.4.dev0-py3-none-any.whl (461.0 kB view details)

Uploaded Python 3

File details

Details for the file arcjetcv-1.1.4.dev0.tar.gz.

File metadata

  • Download URL: arcjetcv-1.1.4.dev0.tar.gz
  • Upload date:
  • Size: 455.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for arcjetcv-1.1.4.dev0.tar.gz
Algorithm Hash digest
SHA256 e1c39511a1d8bccc8e1aeb62ffd0b87fd1614a16f94744b84762a895e48821e6
MD5 76717a3fb85ee220fb5ba9ce84ffcc3a
BLAKE2b-256 c3a266c3f801fb1cd8fb879a2d182968284c164a670286b260927a4792c8559f

See more details on using hashes here.

File details

Details for the file arcjetcv-1.1.4.dev0-py3-none-any.whl.

File metadata

  • Download URL: arcjetcv-1.1.4.dev0-py3-none-any.whl
  • Upload date:
  • Size: 461.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for arcjetcv-1.1.4.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 115c67431484fe27b035fab6cddc973d2ab00fccee86108374005e035092747c
MD5 eb18e0e573b7b1e486527097fe881cc5
BLAKE2b-256 b038d595068567c39cf6c95c11048aa28eb19f2d898644634a4a727c6c5e2628

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page