Skip to content

Getting Started

This section is the shortest route from a PyPI install to a first simulation.

  1. Follow Installation to install the package from PyPI.
  2. Continue with Quickstart to run a minimal 2-D simulation through the public API and inspect the generated output.

What you should have before moving on

  • A working Python environment with Polarism installed.
  • One completed reference run on CPU before enabling GPU execution.
  • A basic sense of where configuration, solver, and output settings live in the API.

After this section

Move to the User Guide once you need to tune grid resolution, timestep selection, pump geometry, reservoir behavior, or output cadence for actual studies.