coilpy

This is a python package for plotting and data processing in stellarator optimization.

It contains several python functions on HDF5, Fourier surfaces, FOCUS, cois, magnetic dipoles, STELLOPT, VMEC, BOOZ_XFORM, etc.

The repository is available at zhucaoxiang/CoilPy.

For full documenation, please check https://zhucaoxiang.github.io/CoilPy/api/coilpy.html.

Submodules

• coilpy.booz_xform
  • BOOZ_XFORM
    • BOOZ_XFORM.from_vmec()
    • BOOZ_XFORM.plot()
    • BOOZ_XFORM.plot2d()
    • BOOZ_XFORM.plot_helicity()
    • BOOZ_XFORM.to_FOCUS()
    • BOOZ_XFORM.write_input()
• coilpy.coils
  • Coil
    • Coil.bfield()
    • Coil.plot()
    • Coil.read_gpec_coils()
    • Coil.read_makegrid()
    • Coil.save_gpec_coils()
    • Coil.save_makegrid()
    • Coil.toVTK()
  • SingleCoil
    • SingleCoil.x
    • SingleCoil.Args
    • SingleCoil.bfield()
    • SingleCoil.bfield_HH()
    • SingleCoil.bfield_fd()
    • SingleCoil.biot_savart()
    • SingleCoil.fourier_tangent()
    • SingleCoil.hanson_hirshman()
    • SingleCoil.interpolate()
    • SingleCoil.magnify()
    • SingleCoil.plot()
    • SingleCoil.plot2d()
    • SingleCoil.rectangle()
    • SingleCoil.spline_tangent()
    • SingleCoil.toVTK()
• coilpy.current_potential
  • Regcoil
    • Regcoil.bfield()
    • Regcoil.bfield_cyl()
    • Regcoil.compute_bn()
    • Regcoil.get_k()
• coilpy.dipole
  • Dipole
    • Dipole.bfield()
    • Dipole.change_momentq()
    • Dipole.from_regcoil()
    • Dipole.full_period()
    • Dipole.inverse()
    • Dipole.mimic()
    • Dipole.open()
    • Dipole.orientation()
    • Dipole.plot()
    • Dipole.plot_rho_profile()
    • Dipole.read_dipole_old()
    • Dipole.round_angle()
    • Dipole.save()
    • Dipole.sp2xyz()
    • Dipole.toVTK()
    • Dipole.truncate()
    • Dipole.volume()
    • Dipole.xyz2sp()
  • GAdipole
• coilpy.focushdf5
  • FOCUSHDF5
    • FOCUSHDF5.Bmod()
    • FOCUSHDF5.Bnorm()
    • FOCUSHDF5.convergence()
    • FOCUSHDF5.curvature()
    • FOCUSHDF5.iota_plot()
    • FOCUSHDF5.plot()
    • FOCUSHDF5.poincare_plot()
    • FOCUSHDF5.toVTK()
• coilpy.hdf5
  • HDF5
    • HDF5.inventory()
• coilpy.magnet
  • Magnet
    • Magnet.divide()
    • Magnet.sub_cubes()
  • corner2magnet()
• coilpy.magtense_interface
  • blocks2tiles()
  • build_prism()
  • corner2tiles()
  • get_center()
  • get_rotmat()
  • magtense2vtk()
  • muse2magntense()
• coilpy.mgrid
  • Mgrid
    • Mgrid.bfield()
    • Mgrid.compute_mgrid()
    • Mgrid.interpolate()
    • Mgrid.read_mgrid_bin()
    • Mgrid.read_mgrid_nc()
    • Mgrid.write_mgrid_nc()
• coilpy.misc
  • biot_savart()
  • booz2focus()
  • colorbar()
  • div0()
  • fft_deriv()
  • get_figure()
  • kwargs2dict()
  • map_matrix()
  • poincare_plot()
  • print_progress()
  • read_focus_boundary()
  • real2trig_2d()
  • rotation_angle()
  • rotation_matrix()
  • scan_focus()
  • set_axes_equal()
  • toroidal_period()
  • tracing()
  • trig2real()
  • trigfft()
  • trigfft2()
  • vmec2focus()
  • vmecMN()
  • write_focus_boundary()
  • xy2rp()
• coilpy.netcdf
  • Netcdf
• coilpy.pm4stell
  • blocks2ficus()
  • blocks2vtk()
  • read_ansys_bfield()
• coilpy.sortedDict
  • SortedDict
    • SortedDict.across()
    • SortedDict.changeKeysCase()
    • SortedDict.check_location()
    • SortedDict.clear()
    • SortedDict.copy()
    • SortedDict.diff()
    • SortedDict.diffKeys()
    • SortedDict.flatten()
    • SortedDict.get()
    • SortedDict.index()
    • SortedDict.insert()
    • SortedDict.items()
    • SortedDict.iteritems()
    • SortedDict.iterkeys()
    • SortedDict.itervalues()
    • SortedDict.keys()
    • SortedDict.moveDown()
    • SortedDict.moveUp()
    • SortedDict.pop()
    • SortedDict.popitem()
    • SortedDict.safe_del()
    • SortedDict.setFlat()
    • SortedDict.setdefault()
    • SortedDict.sort()
    • SortedDict.sort_class()
    • SortedDict.traverse()
    • SortedDict.update()
    • SortedDict.value_for_index()
    • SortedDict.values()
    • SortedDict.walk()
  • buildLocation()
  • dynaLoad()
  • dynaLoadKey()
  • dynaSave()
  • get_bases()
  • parseBuildLocation()
  • parseLocation()
  • pretty_diff()
  • prune_mask()
  • recursiveUpdate()
  • setLocation()
  • size_tree_objects()
  • sortHuman()
  • traverse()
  • traverseLocation()
  • treeLocation()
• coilpy.stellopt
  • OMFITascii
    • OMFITascii.append()
    • OMFITascii.read()
    • OMFITascii.write()
  • STELLout
    • STELLout.load()
    • STELLout.plot()
    • STELLout.plot_balloon()
    • STELLout.plot_helicity()
    • STELLout.plot_neo()
• coilpy.surface
  • FourSurf
    • FourSurf.change_poloidal_angle()
    • FourSurf.get_area()
    • FourSurf.get_volume()
    • FourSurf.grid_box()
    • FourSurf.plot()
    • FourSurf.plot3d()
    • FourSurf.read_focus_input()
    • FourSurf.read_spec_input()
    • FourSurf.read_spec_output()
    • FourSurf.read_vmec_input()
    • FourSurf.read_vmec_output()
    • FourSurf.read_winding_surfce()
    • FourSurf.rz()
    • FourSurf.toSTL()
    • FourSurf.toVTK()
    • FourSurf.write_focus_input()
    • FourSurf.write_vmec_input()
    • FourSurf.xyz()
• coilpy.vmec
  • VMECout
    • VMECout.plot()