API reference
=============

Every module carries its own reasoning: why the model is what it is, what
was tried and rejected, and where the approximations are.

Physics
-------

.. automodule:: exlink.design
.. automodule:: exlink.constants
.. automodule:: exlink.kinematics
.. automodule:: exlink.cycle
.. automodule:: exlink.loads
.. automodule:: exlink.metrics
.. automodule:: exlink.model

Sizing and dynamics
-------------------

The second iteration: inertia in the load path, parts sized against
static, fatigue and buckling failure, and the fixed point that couples them.

.. automodule:: exlink.derivatives
.. automodule:: exlink.materials
.. automodule:: exlink.sections
.. automodule:: exlink.dynamics
.. automodule:: exlink.sizing
.. automodule:: exlink.coupled

Derivatives
-----------

Exact derivatives of the whole chain, which is what makes a gradient-based
optimizer applicable to a feasible set this thin.

.. automodule:: exlink.jacobian
.. automodule:: exlink.dynamics_jacobian

The vehicle-level problem
-------------------------

What turns three competing objectives into one: friction makes the constraint
set cost something, the mass budget converts the envelope and the torque ripple
into kilograms, and the vehicle converts kilograms and efficiency into range.

.. automodule:: exlink.friction
.. automodule:: exlink.gears
.. automodule:: exlink.manufacturing
.. automodule:: exlink.mass_budget
.. automodule:: exlink.vehicle
.. automodule:: exlink.performance

Study of the result
-------------------

Whether the optimum survives manufacturing tolerance -- of the dimensions, and
then of everything else -- how strongly coupled the problem actually is, whether
it survives being asked to run at more than one speed, and whether the finding
generalises past one linkage.

.. automodule:: exlink.robustness
.. automodule:: exlink.uncertainty
.. automodule:: exlink.sampling
.. automodule:: exlink.drivecycle
.. automodule:: exlink.formulations
.. automodule:: exlink.slidercrank
.. automodule:: exlink.synthesis
.. automodule:: exlink.continuation
.. automodule:: exlink.restoration
.. automodule:: exlink.secondorder
.. automodule:: exlink.topology

Mixed-integer design
--------------------

The gear choice is discrete, and it pins the inter-axle distance.  This states
that as a mixed-integer program and solves it by bi-level outer approximation.
Needs the optional ``gemseo-bilevel-outer-approximation`` plugin
(``pip install exlink-opt[minlp]``).

.. automodule:: exlink.minlp

Optimization
------------

.. automodule:: exlink.disciplines
.. automodule:: exlink.scenarios

Visualisation
-------------

.. automodule:: exlink.plots
.. automodule:: exlink.animation
.. automodule:: exlink.diagrams

Command line
------------

.. automodule:: exlink.cli

Reference designs
-----------------

.. automodule:: exlink.reference