API Reference

This page contains auto-generated API reference documentation [1].

• conf
• setup
• stubs
  • stubs.proboscis
• pencil
  • pencil.backpack
    • pencil.backpack.in_ipynb
    • pencil.backpack.module_exists
    • pencil.backpack.pidly
    • pencil.backpack.printProgressBar
  • pencil.calc
    • pencil.calc.Gaussian_averages
    • pencil.calc.Reynolds
    • pencil.calc.accuracy
    • pencil.calc.aver2h5
    • pencil.calc.draglift
    • pencil.calc.example_shocktube
    • pencil.calc.fill_gaps_in_grid
    • pencil.calc.gravity
    • pencil.calc.part_to_grid
    • pencil.calc.shocktube
    • pencil.calc.streamlines
    • pencil.calc.tensors
  • pencil.diag
    • pencil.diag.fixed_points
    • pencil.diag.gas_alpha
    • pencil.diag.particle
      • pencil.diag.particle.diffusion
      • pencil.diag.particle.dispersion_and_drift
      • pencil.diag.particle.gas_velco_at_particle_pos
      • pencil.diag.particle.gas_velo_at_particle_pos
    • pencil.diag.tracers
  • pencil.export
    • pencil.export.arrays2d_to_vtk
    • pencil.export.arrays3d_to_vtk
    • pencil.export.create_h5
    • pencil.export.particles_to_vtk
    • pencil.export.pc2vtk
  • pencil.io
    • pencil.io.change_value_in_file
    • pencil.io.debug_breakpoint
    • pencil.io.dill_exists
    • pencil.io.dill_load
    • pencil.io.dill_save
    • pencil.io.exists_file
    • pencil.io.fort2h5
    • pencil.io.get_systemid
    • pencil.io.get_value_from_file
    • pencil.io.local_fort2h5
    • pencil.io.mkdir
    • pencil.io.npfile
    • pencil.io.pc_hdf5
    • pencil.io.pkl_exists
    • pencil.io.pkl_load
    • pencil.io.pkl_save
    • pencil.io.remove_files
    • pencil.io.rename_in_submit_script
    • pencil.io.snapshot
    • pencil.io.timestamp
    • pencil.io.walklevel
  • pencil.ism_dyn
    • pencil.ism_dyn.derived_h5
    • pencil.ism_dyn.get_masks
    • pencil.ism_dyn.get_stats
    • pencil.ism_dyn.ism_cooling
    • pencil.ism_dyn.ism_sedov_taylor
    • pencil.ism_dyn.rhs_terms
  • pencil.math
    • pencil.math.Helmholtz
    • pencil.math.derivatives
      • pencil.math.derivatives.der
      • pencil.math.derivatives.der_4th_order_w_ghosts
      • pencil.math.derivatives.der_6th_order_w_ghosts
      • pencil.math.derivatives.der_nonequi
      • pencil.math.derivatives.div_grad_curl
      • pencil.math.derivatives.simple_centered
    • pencil.math.general
    • pencil.math.integration
    • pencil.math.interpolation
    • pencil.math.laplace_solver
    • pencil.math.poisson_solver
    • pencil.math.primes
    • pencil.math.stats
      • pencil.math.stats.struct
    • pencil.math.structure_function
    • pencil.math.transform
    • pencil.math.vector_multiplication
  • pencil.pipelines
    • pencil.pipelines.clonesimulations
    • pencil.pipelines.makedict
  • pencil.read
    • pencil.read.allslices
    • pencil.read.averages
    • pencil.read.dims
    • pencil.read.fortran_file
    • pencil.read.grids
    • pencil.read.indices
    • pencil.read.ogdims
    • pencil.read.ogvar
    • pencil.read.params
    • pencil.read.pdfs
    • pencil.read.pdims
    • pencil.read.pencil_record_types
    • pencil.read.phiaverages
    • pencil.read.powers
    • pencil.read.pstalk
    • pencil.read.pstalk2
    • pencil.read.pvarfile
    • pencil.read.timeseries
    • pencil.read.varfile
    • pencil.read.varraw
    • pencil.read.zprof
  • pencil.setup
  • pencil.sim
    • pencil.sim.get
    • pencil.sim.group
    • pencil.sim.remesh
    • pencil.sim.simulation
    • pencil.sim.simulations
    • pencil.sim.sort
  • pencil.tool_kit
    • pencil.tool_kit.field_skeleton
    • pencil.tool_kit.write_forcing_cont
  • pencil.util
  • pencil.visu
    • pencil.visu.animate_interactive
    • pencil.visu.animate_multislices
    • pencil.visu.animate_slices
    • pencil.visu.animate_slices_compareruns
    • pencil.visu.animate_slices_maketomovie
    • pencil.visu.box3d
    • pencil.visu.example_run_pv_plotter
    • pencil.visu.example_run_pv_volume_plotter
    • pencil.visu.internal
      • pencil.visu.internal.MinorSymLogLocator
      • pencil.visu.internal.calc_lims
      • pencil.visu.internal.export_fig
      • pencil.visu.internal.prepare_fig
    • pencil.visu.lic
    • pencil.visu.lic_internal
      • pencil.visu.lic_internal.lic
      • pencil.visu.lic_internal.lic_demo
      • pencil.visu.lic_internal.setup
    • pencil.visu.pv_plotter
    • pencil.visu.pv_plotter_utils
    • pencil.visu.pv_volume_plotter
    • pencil.visu.rvid_box
• pencil_ccyang
  • pencil_ccyang.animate
  • pencil_ccyang.find
  • pencil_ccyang.math
  • pencil_ccyang.plot
  • pencil_ccyang.read
  • pencil_ccyang.write

[1]

Created with sphinx-autoapi