Logo
v0.10.2

Theory

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

Getting Started

  • Installation
  • Command Line Interface
  • Input File
  • Outputs

Examples

  • Using DESC Interactively
  • Using DESC Interactively (Using Spline Basis for profiles)
  • Saving To VMEC-Formatted Output
  • Solving Equilibria with Fixed Axis and Fixed NAE O(rho) Behavior in DESC
  • Solving Current-Constrained Equilibria
  • Precise QA

Tutorials

  • Getting Started With DESC
  • Using a DESC Equilibrium Output
  • Solving Vacuum Equilibria
  • Stellarator Optimization

Developer guides

  • Adding new physics quantities
  • Adding new objective functions
  • Adding new optimizers
  • Collocation grids

Public API

  • API Documentation
    • Basis
    • Coils
    • Continuation
    • Derivatives
    • Equilibrium
    • Examples
    • Geometry
    • Grid
    • IO
    • Magnetic Fields
    • Objective Functions
    • Optimize
    • Perturbations
    • Plotting
    • Profiles
    • Transform
    • VMEC
DESC
  • API Documentation
  • 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 456e535e. Last updated on Oct 27, 2023.

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