Welcome to script_inception_public’s documentation!

Contents:

• README
  • What this is
  • License
  • Windows setup:
  • Blender setup:
    • Notes
  • Links
    • Other useful links/tools
  • Directories for the installation
    • Notes
  • Matlab/Octave scripts
    • If you use Matlab
    • If you use Octave
  • Documentation
  • Git repository location
  • Windows directories
  • Requirements
  • Example python paths
  • Creating VTK files from BFDTD .prn files for 3D visualization
  • Conversion between the HDF, VTK and PRN formats
  • Density of states plotting
• Blender scripts
  • Setting up the Blender Python path:
  • Usage instructions
  • Notes on the python 3 port
    • Not yet ported Blender scripts
      • 1) Layer manager (not yet ported to python3/blender 2.6x)
      • 2) Blender caliper (not yet ported to python3/blender 2.6x)
  • Old installation HOWTO
    • Windows install with Blender 2.6+
    • Windows install with Blender 2.49
      • Example filestructure after installation
    • Quick guide
  • Useful links
• Blender help
  • How to show transparency in object mode
• FDTD
  • Geometry objects
    • Block
    • Sphere
    • Cylinder
    • Distorted
    • Parallelepiped
  • Snapshots
    • The Snapshot module
    • Snapshot objects
      • Snapshot
      • TimeSnapshot
      • ModeFilteredProbe
      • EpsilonSnapshot
      • FrequencySnapshot
      • ModeVolumeBox
  • Meshing
    • meshing.meshing module
    • Mesh objects
      • Mesh3D
      • MultiMesh1D
      • Mesh1D
      • HeterogeneousMesh1D
      • HomogeneousMesh1D
      • HomogeneousMeshParameters1D
  • Excitation objects
    • Excitation
• DLW
• FIB
• package
  • Subpackages
    • FIB package
      • Submodules
      • FIB.FIB module
      • FIB.streamFileTest module
      • Module contents
    • GWL package
      • Submodules
      • GWL.GWL_parser module
      • GWL.SpiralSphere module
      • GWL.bmesh module
      • GWL.box module
      • GWL.foobar_file module
      • GWL.generate_sphere module
      • GWL.parallelepiped module
      • GWL.rotation_example module
      • GWL.tilted_grating module
      • GWL.tube module
      • GWL.woodpile module
      • GWL.woodpile_grid module
      • GWL.SpiralPhasePlate module
      • Module contents
    • bfdtd package
      • Submodules
      • bfdtd.RCD module
      • bfdtd.RCD_waveguides module
      • bfdtd.SpecialTriangularPrism module
      • bfdtd.BFDTDobject module
      • bfdtd.bfdtd_parser module
      • bfdtd.GeometryObjects module
      • bfdtd.bristolFDTD_generator_functions module
      • bfdtd.ellipsoid module
      • bfdtd.excitation module
      • bfdtd.excitationTemplate module
      • bfdtd.excitation_utilities module
      • bfdtd.meshobject module
      • bfdtd.snapshot module
      • bfdtd.triangular_prism module
      • Module contents
    • bin package
      • Submodules
      • bin.addPowerCompensation module
      • bin.bfdtd_rename module
      • bin.bfdtd_tool module
      • bin.bfdtd_tool_gui module
      • bin.comparePeaks module
      • bin.copyBFDTD module
      • bin.efficiency_run module
      • bin.BFDTD_fix_filenames module
      • bin.harminv_wrapper module
      • bin.ncpus module
      • bin.plotAll module
      • bin.processTime module
      • bin.qstat module
      • bin.rerun_with_new_excitation module
      • bin.resonance_run module
      • bin.tdtreat module
      • bin.tiddly2confluence module
      • Module contents
    • constants package
      • Submodules
      • constants.physcon module
      • Module contents
    • crystals package
      • Submodules
      • crystals.RCD_CubicLattice module
      • Module contents
    • functions package
      • Submodules
      • functions.get_neff module
      • Module contents
    • meshing package
      • Submodules
      • meshing.meshing module
      • Module contents
    • special_ops package
      • Submodules
      • special_ops.ReadRotateWrite module
      • special_ops.SO_delimages module
      • special_ops.SO_reportGenerator module
      • special_ops.elliptify module
      • special_ops.woodpile_generator_Xu_rotated_around_Z module
      • Module contents
    • third_party package
      • Submodules
      • third_party.geniegui module
      • Module contents
    • utilities package
      • Submodules
      • utilities.createGUI module
      • utilities.TransformationMatrix module
      • utilities.brisFDTD_ID_info module
      • utilities.common module
      • utilities.dumpObj module
      • utilities.getuserdir module
      • utilities.plotDatFile module
      • utilities.prnutils module
      • Module contents
  • Submodules
  • rotationTest module

Matlab tools

• calculateModeVolume
  • Arguments

Writing documentation

• The reStructuredText Cheat Sheet: Syntax Reminders
  • Section Structure
  • Body Elements
  • Inline Markup
  • Directive Quick Reference
  • Interpreted Text Role Quick Reference
• Sphinx domains Cheat Sheet: Syntax Reminders
  • Overview:
  • Example:

Indices and tables

• Index
• Module Index
• Search Page