API reference¶
Everything public is re-exported from the top-level package, so import complexplorer as cp is all
you need — except engineering mode, which lives under cp.ee. The pages below group the surface by
what you are trying to do rather than by module, because the module layout is internal organisation
that the flat API deliberately hides.
Start with the API map if you know what you want to do but not what to call. The pages below document each group in full.
| Group | What is in it |
|---|---|
| Domains | Rectangle, Disk, Annulus, and set arithmetic |
| Colormaps | Phase, the perceptual families, and the pattern maps |
| Plotting (2D) | plot, pair_plot, the stereographic charts |
| Plotting (3D) | landscapes, the Riemann sphere, Riemann surfaces |
| Scaling | ModulusScaling, get_scaling_preset, and the normalization constant |
| Catalog and presets | catalog, FunctionPreset, PlotPresets, quick_plot, generate_gallery |
| Export | OrnamentGenerator, create_ornament |
| Engineering mode | cp.ee |
| Functions and exceptions | phase, sawtooth, projections, the exception types |
All of it is generated from the docstrings in the source, so it cannot drift from the code.