Metadata-Version: 2.1
Name: qalx-orcaflex
Version: 0.2.6
Summary: qalx bots and helpers for OrcaFlex
License: GPL-3.0+
Author: Steven Rossiter
Author-email: steve@agiletek.co.uk
Requires-Python: >=3.8.0,<4.0.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: docs
Provides-Extra: flaky
Provides-Extra: pip-licenses
Requires-Dist: OrcFxAPI (>=11.0.2,<12.0.0)
Requires-Dist: PyQt5 (>=5.15.1,<6.0.0)
Requires-Dist: pandas (>=1.0.4,<2.0.0)
Requires-Dist: pip-licenses (>=3.5.3,<4.0.0) ; extra == "pip-licenses"
Requires-Dist: psutil (>=5.7.0,<6.0.0)
Requires-Dist: pyqalx (>=0.18.6,<0.19.0)
Requires-Dist: pyyaml (>=5.3.1,<6.0.0)
Requires-Dist: sphinx (>=2.1,<3.0) ; extra == "docs"
Requires-Dist: sphinx-rtd-theme (>=0.4.3,<0.5.0) ; extra == "docs"
Project-URL: Documentation, https://orcaflex.qalx.net
Description-Content-Type: text/markdown

# qalx-orcaflex

Tools to help you run OrcaFlex on [qalx](https://qalx.net).

> To use this package you'll need a **qalx** API key.
> This can be obtained by registering at [qalx.net](https://qalx.net#section-contact). 
>
## Features

The current features are:

- **Batches**: build batches of OrcaFlex data files from various sources
- **Results**: attach some required results which will be extracted automatically when the simulation is complete. The results will also be summarised for each batch
- **Load case information**: results in a batch can be linked to information about the load case
- **Model views**: define a set of model views that will be automatically captured at the end of the simulation
- **Smart statics**: allows you to add object tags that will be used to iteratively find a model that solves in statics

Some planned features:

-  Custom results specification
-  Linked Statistics and Extreme Statistics
-  Model views at key result points (e.g. max of a time history)
-  Model video extraction
-  Optional progress screenshots
-  Automatic batch cancellation on result breach
-  Allowed to define “Model deltas” from a base model
-  Option to extract all model data into qalx (useful if you want to do analytics/ML on model/sim data over time)

## Installation

```bash
pip install qalx-orcaflex
```

## Documentation

[This can be found here.](https://orcaflex.qalx.net)

## Questions?

Please [send us an email (info@qalx.net)](mailto:info@qalx.net)! 

