Logo
v0.12.0

Theory

  • General
  • Basis functions and collocation nodes
  • Perturbation Theory
  • Zernike Polynomial Evaluation
  • List of Variables
  • Optimizers Supported

Tutorials

  • Installation
  • Basic Equilibrium
  • Advanced Equilibrium & Continuation
  • Continuation method step by step
  • Free boundary equilibrium
  • Using a DESC Equilibrium Output
  • Basic Optimization
  • Advanced Optimization
  • Omnigenity Optimization
  • Near axis constraints
  • Bootstrap Current Self-Consistency
  • Stage-Two Filamentary Coil Optimization

Public API

  • Equilibrium, Surfaces, and Profile classes
  • Objectives, Optimizers, and Grids
  • Saving and Loading
  • Plotting
    • 1-D Line Plots
    • Plotting Flux Surfaces
    • Contour Plots of 2-D data
    • 3-D Plotting
    • Specialized Plots for QS Metrics
    • Misc Plotting Utilities
  • Solving and Perturbing
  • Magnetic Fields and Coils
  • Alphabetical Listing

Command Line Interface and I/O

  • Command Line Interface
  • Input File
  • Outputs

Developer guides

  • Adding new physics quantities
  • Adding new objective functions
  • Converting to Cartesian coordinates
  • Adapting Existing Objectives with Different Loss Funtions
  • Adding new optimizers
  • Collocation grids
DESC
  • Plotting
  • desc.plotting.plot_logo
  • Edit on GitHub
Previous Next

desc.plotting.plot_logo

desc.plotting.plot_logo(save_path=None, **kwargs)Source

Plot the DESC logo.

Parameters:
  • save_path (str or path-like) – path to save the figure to. File format is inferred from the filename (Default value = None)

  • **kwargs (dict, optional) – additional plot formatting parameters. options include 'D_color', 'D_color_rho', 'D_color_theta', 'E_color', 'Scolor', 'C_color', 'BGcolor', 'fig_width'

Returns:

  • fig (matplotlib.figure.Figure) – handle to the figure used for plotting

  • ax (matplotlib.axes.Axes) – handle to the axis used for plotting

Examples

../../_images/plot_logo.png
from desc.plotting import plot_logo
plot_logo(save_path='../_static/images/plotting/plot_logo.png')
Previous Next

© Copyright 2020, Plasma Control Group at Princeton University. Revision 87592bc3. Last updated on Jul 18, 2024.

Built with Sphinx using a theme provided by Read the Docs.