flapjax 0.1.1__tar.gz

flapjax-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,33 @@
+name: Deploy documentation
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install docs dependencies
+        run: uv sync --group docs
+
+      - name: Build site
+        run: uv run mkdocs build --strict
+
+      - name: Publish to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          keep_files: true

flapjax-0.1.1/.github/workflows/publish_pypi.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/flapjax/
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Check distributions
+        run: uvx twine check dist/*
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing automatic

flapjax-0.1.1/.github/workflows/python_package.yml

@@ -0,0 +1,29 @@
+name: Run tests and coverage
+
+on: [ push ]
+
+permissions:
+  contents: write
+
+jobs:
+  build-linux:
+    name: python
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install
+        run: uv sync
+
+      - name: Run tests and coverage
+        run: uv run pytest --cov --cov-report json
+
+      - name: Update coverage badge
+        if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+        uses: we-cli/coverage-badge-action@main

flapjax-0.1.1/.gitignore

@@ -0,0 +1,35 @@
+# output files
+*.vts
+*.vtp
+*.vtu
+*.pvd
+*.dat
+*.csv
+*.pickle
+
+# Claude files
+*.claude
+CLAUDE.md
+
+# python files
+*.pyc
+*.egg_info/
+
+# IDE/package manager files
+uv.lock
+.venv
+.idea/
+
+# Mac files
+.DS_Store
+
+# testing files
+tests/test_outputs/
+tests/.jax_cache/
+tmp/
+*.prof
+
+# MkDocs build output
+site/
+.cache/
+

flapjax-0.1.1/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026, Loads Control and Aeroelastics, Imperial College London
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flapjax-0.1.1/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.5
+Name: flapjax
+Version: 0.1.1
+Summary: Solver for computing aeroelastic responses and corresponding design derivatives.
+Project-URL: Homepage, https://ben-l-p.github.io/flapjax/
+Project-URL: Documentation, https://ben-l-p.github.io/flapjax/
+Project-URL: Repository, https://github.com/ben-l-p/flapjax
+Project-URL: Issues, https://github.com/ben-l-p/flapjax/issues
+Author-email: Ben Preston <b.preston23@imperial.ac.uk>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: adjoint methods,aeroelasticity,nonlinear beam,unsteady vortex lattice method
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.12
+Requires-Dist: jax>=0.9
+Requires-Dist: matplotlib>=3.10
+Requires-Dist: numpy>=2.4
+Requires-Dist: scipy>=1.17
+Requires-Dist: vtk>=9.6
+Description-Content-Type: text/markdown
+
+# FLAPJAX — FLexible Aeroelastic Panel code in JAX
+
+*nonlinear · differentiable · adjoint-enabled*
+
+![Tests](https://github.com/ben-l-p/flapjax/actions/workflows/python_package.yml/badge.svg)
+[![cov](https://ben-l-p.github.io/flapjax/badges/coverage.svg)](https://github.com/ben-l-p/flapjax/actions)
+[![Docs](https://img.shields.io/badge/docs-mkdocs-blue)](https://ben-l-p.github.io/flapjax/)
+[![PyPI](https://img.shields.io/pypi/v/flapjax)](https://pypi.org/project/flapjax/)
+![Python](https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/ben-l-p/flapjax/main/pyproject.toml)
+
+FLAPJAX is a differentiable nonlinear aeroelastic analysis framework which couples a nonlinear structural model with
+unsteady vortex lattice method (UVLM) aerodynamics. This allows for a range of structural, aerodynamic and coupled
+analyses, with gradients available using the adjoint method. The full codebase is implemented in JAX, which allows for
+efficient automatic differentiation, GPU acceleration and multi-case parallelisation.
+
+Full documentation, including tutorials, API reference and theory, is available at
+[ben-l-p.github.io/flapjax](https://ben-l-p.github.io/flapjax/).
+
+## Installation
+
+Installation is available using PyPi with:
+
+```bash
+pip install flapjax
+```
+
+Cloning the full repository and installing with uv is also supported, which allows for development installation:
+
+```bash
+uv sync
+```
+
+An extensive test suite is included to verify the correctness of the code. This verified the numerics, and takes
+approximately 30 minutes to run on an M2 MacBook Air. Tests can be run using pytest.
+
+```bash
+uv run pytest
+```
+
+
+

flapjax-0.1.1/README.md

@@ -0,0 +1,41 @@
+# FLAPJAX — FLexible Aeroelastic Panel code in JAX
+
+*nonlinear · differentiable · adjoint-enabled*
+
+![Tests](https://github.com/ben-l-p/flapjax/actions/workflows/python_package.yml/badge.svg)
+[![cov](https://ben-l-p.github.io/flapjax/badges/coverage.svg)](https://github.com/ben-l-p/flapjax/actions)
+[![Docs](https://img.shields.io/badge/docs-mkdocs-blue)](https://ben-l-p.github.io/flapjax/)
+[![PyPI](https://img.shields.io/pypi/v/flapjax)](https://pypi.org/project/flapjax/)
+![Python](https://img.shields.io/python/required-version-toml?tomlFilePath=https://raw.githubusercontent.com/ben-l-p/flapjax/main/pyproject.toml)
+
+FLAPJAX is a differentiable nonlinear aeroelastic analysis framework which couples a nonlinear structural model with
+unsteady vortex lattice method (UVLM) aerodynamics. This allows for a range of structural, aerodynamic and coupled
+analyses, with gradients available using the adjoint method. The full codebase is implemented in JAX, which allows for
+efficient automatic differentiation, GPU acceleration and multi-case parallelisation.
+
+Full documentation, including tutorials, API reference and theory, is available at
+[ben-l-p.github.io/flapjax](https://ben-l-p.github.io/flapjax/).
+
+## Installation
+
+Installation is available using PyPi with:
+
+```bash
+pip install flapjax
+```
+
+Cloning the full repository and installing with uv is also supported, which allows for development installation:
+
+```bash
+uv sync
+```
+
+An extensive test suite is included to verify the correctness of the code. This verified the numerics, and takes
+approximately 30 minutes to run on an M2 MacBook Air. Tests can be run using pytest.
+
+```bash
+uv run pytest
+```
+
+
+

flapjax-0.1.1/docs/index.md

@@ -0,0 +1,70 @@
+# flapjax
+
+**flapjax** (COupled Nonlinear Differentiable solver fOR aeroelastics) is a nonlinear aeroelastic solver build using
+Google JAX. It couples:
+
+- **UVLM** (Unsteady Vortex Lattice Method) for aerodynamics
+- **Nonlinear beam theory** (SE (3)/SO (3) Lie-group formulation) for structural mechanics
+
+This allows for accurate simulation of highly flexible aircraft configurations. Capabilities for simulation include:
+
+- **Static aeroelastic analysis** for finding the equilibrium configuration
+- **Dynamic aeroelastic analysis** for time-domain response to gusts and control inputs
+- **Linearised aeroelastic analysis** for structural modal, and aeroelastic stability and flutter analysis
+- **Adjoint-based gradients** for efficient sensitivity computation of static and dynamic systems, enabling
+  gradient-based optimisation
+
+There are many advantages for using a fully JAX-based framework, including:
+
+- **Fast analysis** using JAX's just-in-time compilation
+- **Parallelisation** using JAX's vectorisation and batching capabilities, which allows for parallelising across
+  multiple cases, as well as within a single case. This supports execution on CPU and GPU hardware.
+- **Automatic differentiation** of Python functions, which allows for an elegant implementation of adjoint and
+  linearised systems.
+
+It is advised that users have an understanding of key JAX principles, including JIT compilation, vectorisation, and
+automatic differentiation [JAX documentation](https://docs.jax.dev/en/latest/notebooks/thinking_in_jax.html). This can
+often result in unusual coding patterns due to the absense of conventional control logic.
+
+This framework is designed to be modular, and allows for very flexible workflows. It makes extensive use of
+object-oriented principles with a very "pythonic" interface. It makes full use of Python type hinting to best inform
+users of the expected input and output types for each function.
+
+## Where to go next
+
+<div class="grid cards" markdown>
+
+- :material-school: **[Tutorials](tutorials/index.md)**
+  Example-based guides.
+
+- :material-book-open-variant: **[Reference](reference/index.md)**
+  API documentation.
+
+- :material-lightbulb: **[Theory](theory/index.md)**
+  Theoretical background behind the aeroelastic modelling.
+
+</div>
+
+## Installation
+
+Installation is simple, supporting pip installation. It is recommended to install in a virtual environment, with ``uv``
+being the recommended package manager. The following commands will install the package with all dependencies, including
+optional dependencies for development.
+
+Recommended installation with ``uv``:
+
+```bash
+uv sync --no-dev   # runtime only
+```
+
+Development installation with ``uv``:
+
+```bash
+uv sync            # runtime + dev
+```
+
+For installation without ``uv`` (for instance if using Conda), we can fall back to ``pip``:
+
+```bash
+pip install .
+```

flapjax-0.1.1/docs/javascripts/mathjax.js

@@ -0,0 +1,24 @@
+/* global MathJax, document$ */
+window.MathJax = {
+    tex: {
+        inlineMath: [["\\(", "\\)"]],
+        displayMath: [["\\[", "\\]"]],
+        processEscapes: true,
+        processEnvironments: true
+    },
+    options: {
+        ignoreHtmlClass: ".*|",
+        processHtmlClass: "arithmatex"
+    }
+};
+
+document$.subscribe(() => {
+    // noinspection JSUnresolvedReference
+    MathJax.startup.output.clearCache();
+    // noinspection JSUnresolvedReference
+    MathJax.typesetClear();
+    // noinspection JSUnresolvedReference
+    MathJax.texReset();
+    // noinspection JSUnresolvedReference
+    MathJax.typesetPromise();
+});

flapjax-0.1.1/docs/reference/aero.md

@@ -0,0 +1,3 @@
+# Aero
+
+::: flapjax.aero

flapjax-0.1.1/docs/reference/algebra.md

@@ -0,0 +1,3 @@
+# Algebra
+
+::: flapjax.algebra

flapjax-0.1.1/docs/reference/coupled.md

@@ -0,0 +1,3 @@
+# Coupled
+
+::: flapjax.coupled

flapjax-0.1.1/docs/reference/index.md

@@ -0,0 +1,9 @@
+# API reference
+
+Auto-generated from docstrings via [`mkdocstrings`](https://mkdocstrings.github.io/).
+
+- [Aero](aero.md) — UVLM, AIC kernels, wake models
+- [Structure](structure.md) — Cosserat beam, time integration
+- [Coupled](coupled.md) — static and dynamic aeroelastic solvers
+- [Algebra](algebra.md) — SO (3)/SE (3) Lie-group primitives
+- [Utils](utils.md) — pytree helpers, convergence settings, design variables

flapjax-0.1.1/docs/reference/structure.md

@@ -0,0 +1,3 @@
+# Structure
+
+::: flapjax.structure

flapjax-0.1.1/docs/reference/utils.md

@@ -0,0 +1,3 @@
+# Utils
+
+::: flapjax.utils

flapjax-0.1.1/docs/stylesheets/extra.css

@@ -0,0 +1,10 @@
+.jp-OutputArea-output pre {
+    max-height: 24rem;
+    overflow: auto;
+    resize: vertical;
+}
+
+.jp-OutputArea-output.jp-OutputArea-stderr {
+    max-height: 24rem;
+    overflow: auto;
+}

flapjax-0.1.1/docs/theory/adjoint.md

@@ -0,0 +1,3 @@
+# Discrete adjoint
+
+TODO