Skip to content

Commit

Permalink
docs: tidied docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kieran-mackle committed Dec 12, 2023
1 parent 036910f commit a8ae8a7
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 32 deletions.
26 changes: 3 additions & 23 deletions docs/source/documentation/components.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,7 @@
# HYPERVEHICLE Components

The *hypervehicle* package employs a component build up approach.
Using the core component types, a wide range of geometries can
be constructed. While there is an upfront cost associated with
constructing a good parametric model, the generalised nature of
*hypervehicle* allows you to programmatically define relationships
between geometric components.


## The *hypervehicle* Workflow
Before diving into the component definitions, this section provides
an overview of the *hypervehicle* workflow, and how geometries are
created from arbitrary definitions.

A vehicle is constructed by stacking a collection of *components*
together. Each component type defined below inherits from the
{py:class}`.Component` class.

Below is a summary of other terminology:
- Patch: a *patch* is a surface represented by a continuous function
- Surface: a *surface* is a surface represented by a discrete function
- Mesh: a *mesh* is a [Numpy STL](https://numpy-stl.readthedocs.io/en/latest/stl.html#stl-mesh) object
# HyperVehicle Components

As described in the [HyperVehicle overview](overview), a component-based approach is
used to construct geometries. This page details the base components available.


## General Component Types
Expand Down
25 changes: 25 additions & 0 deletions docs/source/documentation/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
(overview)=
# Overview of HyperVehicle

The *hypervehicle* package employs a component build up approach.
Using the core component types, a wide range of geometries can
be constructed. While there is an upfront cost associated with
constructing a good parametric model, the generalised nature of
*hypervehicle* allows you to programmatically define relationships
between geometric components.


## The *HyperVehicle* Workflow
Before diving into the component definitions, this section provides
an overview of the *hypervehicle* workflow, and how geometries are
created from arbitrary definitions.

A vehicle is constructed by stacking a collection of *components*
together. Each component type defined below inherits from the
{py:class}`.Component` class.

Below is a summary of other terminology:
- Patch: a *patch* is a surface represented by a continuous function
- Surface: a *surface* is a surface represented by a discrete function
- Mesh: a *mesh* is a [Numpy STL](https://numpy-stl.readthedocs.io/en/latest/stl.html#stl-mesh) object

2 changes: 1 addition & 1 deletion docs/source/documentation/vehicle.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Building a Vehicle with *hypervehicle*
# Building a Vehicle with *HyperVehicle*

Docs coming soon! The following will be addressed:
- creating a vehicle instance
Expand Down
5 changes: 3 additions & 2 deletions docs/source/examples/x43.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Hypervehicle Geometry Generation Example
# X-43A Demonstrator Tutorial

![X43A Example](../images/hangar/x43a.png)
<!-- ![X43A Example](../images/hangar/x43a.png) -->
![X43 Example](../images/x43.gif)

This page covers how to build a parametric model resembling the X-43A
flight demonstrator.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/hangar.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Vehicle Hangar
# HyperVehicle Hangar

This page is a showcase of vehicle geometries possible using *hypervehicle*.
Note that all of these vehicles can be accessed via the `hypervehicle.hangar`
Expand Down
11 changes: 6 additions & 5 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ then have a look at the [examples](examples/x43).
:hidden:
:caption: SHOWCASE
Vehicle Hangar <hangar>
Hangar <hangar>
```


Expand All @@ -37,9 +37,10 @@ Vehicle Hangar <hangar>
:caption: DOCUMENTATION
Getting Started <getting-started>
Building Components <documentation/components>
Building Vehicles <documentation/vehicle>
Extracting Sensitivities <documentation/sensitivity>
Overview <documentation/overview>
Components <documentation/components>
Vehicles <documentation/vehicle>
Parametric Sensitivities <documentation/sensitivity>
```


Expand All @@ -50,7 +51,7 @@ Extracting Sensitivities <documentation/sensitivity>
Sharp Wedge <examples/wedge>
NASA X-43A <examples/x43>
Parameter Sensitivities <examples/sensitivity>
Extracting Sensitivities <examples/sensitivity>
```


Expand Down

0 comments on commit a8ae8a7

Please sign in to comment.