API Reference

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

• angles
• algebra
• helpers
• shnitsel
  • shnitsel._accessors
  • shnitsel._contracts
  • shnitsel._generated_accessors
  • shnitsel._state
  • shnitsel.analyze
    • shnitsel.analyze.generic
    • shnitsel.analyze.hops
    • shnitsel.analyze.lda
    • shnitsel.analyze.pca
    • shnitsel.analyze.pls
    • shnitsel.analyze.populations
    • shnitsel.analyze.spectra
    • shnitsel.analyze.stats
  • shnitsel.bridges
  • shnitsel.clean
    • shnitsel.clean.common
    • shnitsel.clean.dispatch_plots
    • shnitsel.clean.filter_energy
    • shnitsel.clean.filter_geo
    • shnitsel.clean.filtration_class
  • shnitsel.core
    • shnitsel.core._api_info
    • shnitsel.core.feature_detection
    • shnitsel.core.typedefs
  • shnitsel.data
    • shnitsel.data.atom_helpers
    • shnitsel.data.charge_helpers
    • shnitsel.data.dataset_containers
      • shnitsel.data.dataset_containers.data_series
      • shnitsel.data.dataset_containers.dataset_vis
      • shnitsel.data.dataset_containers.frames
      • shnitsel.data.dataset_containers.inter_state
      • shnitsel.data.dataset_containers.multi_layered
      • shnitsel.data.dataset_containers.multi_series
      • shnitsel.data.dataset_containers.multi_stacked
      • shnitsel.data.dataset_containers.per_state
      • shnitsel.data.dataset_containers.shared
      • shnitsel.data.dataset_containers.trajectory
      • shnitsel.data.dataset_containers.trajectory_collection
      • shnitsel.data.dataset_containers.xr_conversion
    • shnitsel.data.helpers
    • shnitsel.data.multi_indices
    • shnitsel.data.proxy_class
    • shnitsel.data.shnitsel_db
      • shnitsel.data.shnitsel_db.db_function_decorator
    • shnitsel.data.shnitsel_db_helpers
    • shnitsel.data.state_helpers
    • shnitsel.data.traj_combiner_methods
    • shnitsel.data.trajectory_grouping_params
    • shnitsel.data.trajectory_variable_description
    • shnitsel.data.tree
      • shnitsel.data.tree.child_support_functions
      • shnitsel.data.tree.compound
      • shnitsel.data.tree.data_group
      • shnitsel.data.tree.data_leaf
      • shnitsel.data.tree.datatree_level
      • shnitsel.data.tree.node
      • shnitsel.data.tree.selection
      • shnitsel.data.tree.support_functions
      • shnitsel.data.tree.tree
      • shnitsel.data.tree.tree_completion
      • shnitsel.data.tree.tree_vis
      • shnitsel.data.tree.xr_conversion
    • shnitsel.data.xr_io_compatibility
    • shnitsel.data.xr_io_registry
  • shnitsel.filtering
    • shnitsel.filtering.helpers
    • shnitsel.filtering.state_selection
    • shnitsel.filtering.structure_selection
  • shnitsel.geo
    • shnitsel.geo.alignment
    • shnitsel.geo.analogs
    • shnitsel.geo.geocalc
  • shnitsel.io
    • shnitsel.io.ase
      • shnitsel.io.ase.format_reader
      • shnitsel.io.ase.parse
      • shnitsel.io.ase.write
    • shnitsel.io.format_reader_base
    • shnitsel.io.format_registry
    • shnitsel.io.newtonx
      • shnitsel.io.newtonx.format_reader
      • shnitsel.io.newtonx.parse
    • shnitsel.io.pyrai2md
      • shnitsel.io.pyrai2md.format_reader
      • shnitsel.io.pyrai2md.parse
    • shnitsel.io.read
    • shnitsel.io.sharc
      • shnitsel.io.sharc.format_reader
      • shnitsel.io.sharc.parse_initial_conditions
      • shnitsel.io.sharc.parse_trajectory
      • shnitsel.io.sharc.qm_helpers
    • shnitsel.io.shnitsel
      • shnitsel.io.shnitsel.format_reader
      • shnitsel.io.shnitsel.parse
      • shnitsel.io.shnitsel.write
    • shnitsel.io.xyz
      • shnitsel.io.xyz.parse
  • shnitsel.rd
  • shnitsel.units
    • shnitsel.units.conversion
    • shnitsel.units.defaults
    • shnitsel.units.definitions
  • shnitsel.vis
    • shnitsel.vis.colormaps
    • shnitsel.vis.datasheet
      • shnitsel.vis.datasheet.datasheet
      • shnitsel.vis.datasheet.datasheet_page
      • shnitsel.vis.datasheet.figures
        • shnitsel.vis.datasheet.figures.common
        • shnitsel.vis.datasheet.figures.dip_trans_hist
        • shnitsel.vis.datasheet.figures.energy_bands
        • shnitsel.vis.datasheet.figures.hist
        • shnitsel.vis.datasheet.figures.nacs_hist
        • shnitsel.vis.datasheet.figures.per_state_hist
        • shnitsel.vis.datasheet.figures.soc_trans_hist
        • shnitsel.vis.datasheet.figures.socs_hist
        • shnitsel.vis.datasheet.figures.structure
        • shnitsel.vis.datasheet.figures.time
    • shnitsel.vis.plot
      • shnitsel.vis.plot.common
      • shnitsel.vis.plot.filtration
      • shnitsel.vis.plot.kde
      • shnitsel.vis.plot.p3mhelpers
      • shnitsel.vis.plot.pca_biplot
      • shnitsel.vis.plot.polychrom
      • shnitsel.vis.plot.select
      • shnitsel.vis.plot.spectra3d
      • shnitsel.vis.plot.time
    • shnitsel.vis.static
      • shnitsel.vis.static.css
      • shnitsel.vis.static.html
    • shnitsel.vis.support
      • shnitsel.vis.support.ipython_visualization
      • shnitsel.vis.support.multi_plot
      • shnitsel.vis.support.visualizeable
    • shnitsel.vis.vmd
  • shnitsel.xarray
• pyramids
• messages
• positions
• distances
• dihedrals
• molcas_opt
• bla_chromophor
• trajectory_setup
• variable_flagging
• generate_datasheet
• convert_to_shnitsel
• merge_shnitsel_files
• trajectory_verification
• trajectory_finalization

[1]

Created with sphinx-autoapi