AVLWrapper
Python interface for MIT AVL (Athena Vortex Lattice)
Description
Currently implemented:
Geometry definition
Case definition
Running operating-point run cases
Results parsing
Not implemented (yet):
Mass definition
Eigen-mode analyses
Time-domain analyses
Installation
AVLWrapper can be installed from PyPI:
$ pip install avlwrapper
Or can be installed from Git:
$ pip install git+https://github.com/renoelmendorp/AVLWrapper.git@master
Requirements
AVL (link) should be installed. If installed on a location in $PATH or in the module directory, the wrapper will locate it with the default configuration. See Changing settings how to change the executable path to a custom location.
(optional) Ghostscript is required to convert and save plots as pdf, jpeg, or png. Ghostscript can be installed on Linux/MacOS with a package manager:
Linux:
$ apt-get install ghostscript
MacOS:
$ brew install ghostscript
For Windows, Ghostscript can be found on the website.
Usage
For usage examples, see the example.ipynb notebook.
Changing settings
To change settings, make a local copy of the settings file:
from avlwrapper import default_config
default_config.local_copy()By default the wrapper will look for a configuration file in the working directory and module directory. If you would like to use a different configuration file, you need to give the path to the session:
from avlwrapper import Configuration
my_config = Configuration(path_to_file)
session = Session(..., config=my_config)Development
Tests
To run tests in development, first install the development requirement into your environment:
pip install -r requirements-dev.txtThen, from the source directory of the repo:
pytest -vv tests
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file avlwrapper-0.4.0.tar.gz.
File metadata
- Download URL: avlwrapper-0.4.0.tar.gz
- Upload date:
- Size: 34.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a03bbfc1e2be74a09365e8b0b937c78fa5bf80f737eda5e359ab764ab7277bad
|
|
| MD5 |
c197ed076cf4dc4963f010a5a61e5ce2
|
|
| BLAKE2b-256 |
e5e3a080a1bc4d4a2d18c8bbe5269de6037a9a241a812a3324fb9d1b83594b11
|
File details
Details for the file avlwrapper-0.4.0-py3-none-any.whl.
File metadata
- Download URL: avlwrapper-0.4.0-py3-none-any.whl
- Upload date:
- Size: 35.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
941e2760e974ba9f0d33cec26cbe3ab5e41fac272dc140d3efbb3fa5367a58b8
|
|
| MD5 |
42a70e29ca33a0613bad9c2534e44af1
|
|
| BLAKE2b-256 |
1ec9cd07289536ca1205933ed6eb1f31783dd0e87a16cacbe06791581bab4127
|
