API Reference

Full reference documentation for all public modules in FORGE, auto-generated from the source code docstrings.

• forge.equilibrium
  • Equilibrium
• forge.machine
  • Machine
• forge.magnets
  • Coil
  • ShapedCoil
  • Solenoid
  • FilamentPointCoil
  • Circuit
• forge.greens
  • Greens()
  • Greens_dpsi_dR()
  • Greens_dpsi_dZ()
  • Greens_d2psi_dR2()
  • Greens_d2psi_dZ2()
  • Greens_d2psi_dR_dZ()
  • Greens_Br()
  • Greens_Bz()
  • Greens_dBr_dR()
  • Greens_dBr_dZ()
  • Greens_dBz_dR()
  • Greens_dBz_dZ()
• forge.critical
  • find_critical()
  • core_mask()
  • find_psisurface()
  • find_separatrix()
• forge.optimise
  • Optimiser
• forge.plotting
  • plot_profiles()
  • plot_equilibrium()
  • plot_fluxes()
  • plot_fields()
  • plot_optimiser_state()
  • plot_currents_comparison_bar_chart()
  • plot_optimisation_summary()
• forge.io
  • read_geqdsk()
  • read_magnets()
  • write_magnets()
  • write_geqdsk()
  • fancy_json_string()
  • save_fancy_json()
  • save_optimiser()
  • load_optimiser()
  • save_strike_geometry()
  • load_strike_geometry()
  • save_optimisation_config()
  • load_optimisation_config()
• forge.quadrature
  • triangle_quad()
  • polygon_quad()
  • average()
• forge.utils
  • filter_distant_points()
  • magnitude_scale_factors()
  • reflect_and_join_shape()
  • interactive_shape_editor()
  • plot_currents_comparison_bar_chart()
  • interactive_buffered_polygon()
  • draw_shape()
  • densify_closed_shape()
  • calc_winding_number()
  • estimate_xpoint_location()
  • grid_points_inside_linestring()
  • closest_point_along_shape()
  • update_figure()
  • force_opaque_figure()
  • orthogonalised_convex_hull_from_rects()