User manual

• Installation for users
  • On a cloud platform
  • Locally with the uv package manager
  • As a standalone executable
  • Installing with pip package manager
  • Installing with Conda package manager
  • More build recipes
• Quickstart
• Tutorial
  • Main concepts
  • Step-by-step example
• Meshes
  • Naming
  • Mesh initialization
  • Display
  • Geometric transformations
  • Extracting or generating a lid
  • Defining an integration quadrature
• Floating body
  • Initialization
  • Display and animation
  • Geometric transformations
• Multiple bodies
• Hydrostatics
  • Hydrostatic stiffness
  • Inertia matrix
• Mesh symmetries
  • Defining a symmetric mesh
  • Manipulating a symmetric mesh
  • Using a symmetric mesh to define a floating body
  • Expected performance gain
• Setting up a problem
  • Defining a test matrix with xarray
  • The LinearPotentialFlowProblem class
  • Importing a dataset from Bemio
  • Legacy Nemoh.cal parameters files
  • Command-line interface
• Resolution
  • Settings of the solver
  • Solving the problem
  • Progress bar
  • Timer
  • RAM usage
  • Parallelization
• Post-processing and collection in dataset
  • Outputs stored in LinearPotentialFlowResult
  • Building a dataframe or a dataset from LinearPotentialFlowResult
  • Pressure, velocity, free surface elevation
  • Impedance and RAO
  • Kochin functions
  • Mean drift forces
• Export outputs
  • NetCDF format
  • Wamit format
  • Nemoh format
  • Excel format
• Conventions and differences to other codes
  • With respect to WAMIT or Orcawave
  • With respect to Nemoh and Aquadyn
  • With respect to HAMS
  • With respect to Hydrostar
• Common issues
  • There are NaNs in my dataset output
  • My results does not match the ones of this other code
  • The added mass and radiation damping matrices are not symmetric