Open-CRAVAT

jQuery UI Touch Punch is a small hack that enables touch event support (touchstart, touchmove, touchend) for sites using the jQuery UI library. Because jQuery UI natively listens for mouse events (mouseover, mousemove, mouseout), it often fails on mobile devices. Touch Punch works by using simulated events to map touch events to their corresponding mouse event analogs.

Note: Touch Punch works by monkey-patching (duck punching) some of jQuery UI's core functionality. While it works with all basic implementations of jQuery UI interactions and widgets, complex cases may occasionally fail.

Open-CRAVAT uses Celery for background job processing.

• Single-user mode: If the GUI is running in single-user mode, Celery workers are spawned automatically.
• Multi-user mode: You must manually start Celery workers in a separate process. Use the dotted Python path cravat.gui.celery to point to the configured Celery App instance.

You can use standard celery CLI flags (e.g., --help) to configure worker behavior, such as restricting specific queues.

celery -A cravat.gui.celery worker

To enable touch events in your jQuery UI application, follow these steps in order:

1. Include jQuery and jQuery UI on your page.
2. Include Touch Punch after jQuery UI and before its first use.
   • Critical: If you are using specific jQuery UI components, Touch Punch must be included after jquery.ui.mouse.js because it modifies that module's behavior.
3. Use your jQuery UI widgets/interactions as normal.

<!-- 1. Include jQuery and jQuery UI -->
<script src="http://code.jquery.com/jquery.min.js"></script>
<script src="http://code.jquery.com/ui/1.8.17/jquery-ui.min.js"></script>

<!-- 2. Include Touch Punch after jQuery UI -->
<script src="jquery.ui.touch-punch.min.js"></script>

<!-- 3. Use jQuery UI as expected -->
<script>$('#widget').draggable();</script>

For detailed installation instructions, software documentation, and API references, visit the official Open-CRAVAT documentation site.

https://open-cravat.readthedocs.io/en/latest/index.html

To launch the Open-CRAVAT graphical user interface using the default Flask server, first ensure the package is installed in editable mode, then use the oc gui command.

If you specifically require the aiohttp server implementation, use the --aiohttp flag. Note that aiohttp support is considered experimental and may be deprecated in future versions.

python -m pip install -e .
oc gui

# To use the aiohttp server instead:
oc gui --aiohttp

Use the oc module install command to set up the core environment. You can install base modules and specific reporters like excelreporter, textreporter, and tsvreporter.

oc module install-base
oc module install -y excelreporter
oc module install -y textreporter
oc module install -y tsvreporter

You can perform a test analysis by first generating an example input file and then running the cravat command. Running cravat on an input file produces several files, the primary output being an Excel file (<input_file>.xlsx).

# Create an example input file in the current directory
!cravat-admin make-example-input .

# Run the analysis
!cravat example_input

Install the core Open-CRAVAT package using pip.

pip install open-cravat