Metadata-Version: 2.1
Name: hypervehicle
Version: 0.7.1
Summary: Parametric geometry generation tool for hypersonic vehicles
Author-email: Kieran Mackle <kemackle98@gmail.com>
Project-URL: Homepage, https://github.com/kieran-mackle/hypervehicle
Project-URL: Bug Tracker, https://github.com/kieran-mackle/hypervehicle/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: numpy-stl>=3.0.0
Requires-Dist: scipy>=1.10.0
Requires-Dist: pandas>=1.5.2
Requires-Dist: art>=5.8
Requires-Dist: tqdm>=4.64.1
Requires-Dist: multiprocess>=0.70.14
Requires-Dist: pymeshfix>=0.16.2
Provides-Extra: dev
Requires-Dist: pytest>=7.2.1; extra == "dev"
Requires-Dist: black>=23.9.1; extra == "dev"
Requires-Dist: commitizen>=3.10.0; extra == "dev"
Requires-Dist: pre-commit>=3.4.0; extra == "dev"
Requires-Dist: furo>=2022.12.7; extra == "dev"
Requires-Dist: myst_parser>=0.18.1; extra == "dev"
Requires-Dist: sphinx_copybutton>=0.5.1; extra == "dev"
Requires-Dist: sphinx_inline_tabs>=2022.1.2b11; extra == "dev"
Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "dev"

[![x43](docs/source/images/logo-dark.png)](docs/hangar.md)

<p align="center">
  
  <a href="https://pypi.org/project/hypervehicle/">
    <img src="https://img.shields.io/pypi/v/hypervehicle?color=blue&style=plastic" alt="Latest version" width=95 height=20>
  </a>
  
  <a href="https://github.com/psf/black">
    <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
  </a>

  <a href="https://kieran-mackle.github.io/hypervehicle/pytest_report">
    <img src="https://github.com/kieran-mackle/hypervehicle/actions/workflows/tests.yml/badge.svg" alt="Test Status" >
  </a>

  <a href="https://kieran-mackle.github.io/hypervehicle/coverage">
    <img src="https://github.com/kieran-mackle/hypervehicle/raw/gh-pages/coverage.svg?raw=true" alt="Test Coverage" >
  </a>
  
</p>

A Python package to rapidly generate parametric geometries
defined by hyperpatches. Check out the 
[hangar](docs/source/hangar.md) for some examples.


## Installation

To install `hypervehicle` from [PyPI](https://pypi.org/project/hypervehicle/), use the command below.

```
pip install hypervehicle
```

### Developing HyperVehicle
Contributions to HyperVehicle are welcome. Please refer to the [contribution guidelines](https://hypervehicle.readthedocs.io/en/latest/other/contributing.html) for guidance.


## Citing HyperVehicle
If you use HyperVehicle in any published work, please cite it using the BibTex reference below.

```text
@inproceedings{Mackle2024,
  author    = {Mackle, Kieran and Jahn, Ingo},
  booktitle = {AIAA Science and Technology Forum and Exposition},
  title     = {Efficient and Flexible Methodology for the Aerodynamic Shape Optimisation of Hypersonic Vehicle Concepts in a High-Dimensional Design Space},
  year      = {2024},
}
```

## License
HyperVehicle is licensed under [GPLv3](COPYING).
