Skip to main content

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

Project description

Documentation Status Anaconda-Server Badge tutorial


arcjetCV Logo

arcjetCV

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

arcjetCV Functionality

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:

To install arcjetCV for development puropse, 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.

Note for macOS Users:

You might need to install Xcode Command Line Tools:

xcode-select --install

How to Run

You can now launch the GUI by running:

conda activate arcjetCV
arcjetCV

or you can import arcjetCV's python API inside a python script, e.g. test.py:

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

and then run it as:

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.

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.0.dev1.tar.gz (449.8 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.0.dev1-py3-none-any.whl (455.9 kB view details)

Uploaded Python 3

File details

Details for the file arcjetcv-1.1.0.dev1.tar.gz.

File metadata

  • Download URL: arcjetcv-1.1.0.dev1.tar.gz
  • Upload date:
  • Size: 449.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for arcjetcv-1.1.0.dev1.tar.gz
Algorithm Hash digest
SHA256 5ee415b317b39b1b02273d4eaf531c391b59ae1cca43e9c82022d3ec17ff7627
MD5 52907cda907d3772ce912adfba8df344
BLAKE2b-256 4c7f2a4202213bb0a236b523d8c14ed53bb6a1236200e523e8464596fa12b34d

See more details on using hashes here.

File details

Details for the file arcjetcv-1.1.0.dev1-py3-none-any.whl.

File metadata

  • Download URL: arcjetcv-1.1.0.dev1-py3-none-any.whl
  • Upload date:
  • Size: 455.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for arcjetcv-1.1.0.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 8fa310e47f9e2e9413c20fd3165a1be3ab8322c180bf0dd0fd6af34caf7c8c11
MD5 e63efef6e03f8e58dcab852cdd0287a1
BLAKE2b-256 291706861e2390a9dcad74678341c63344cd0aa4b99050885736e8badc6f92e7

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