pyiron\_atomistics.sphinx.interactive.SphinxInteractive
=======================================================

.. currentmodule:: pyiron_atomistics.sphinx.interactive

.. autoclass:: SphinxInteractive
   :members:
   :show-inheritance:
   :inherited-members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~SphinxInteractive.__init__
      ~SphinxInteractive.animate_structure
      ~SphinxInteractive.animate_structures
      ~SphinxInteractive.calc_md
      ~SphinxInteractive.calc_minimize
      ~SphinxInteractive.calc_static
      ~SphinxInteractive.check_if_job_exists
      ~SphinxInteractive.check_setup
      ~SphinxInteractive.check_vasp_potentials
      ~SphinxInteractive.clear_job
      ~SphinxInteractive.collect_errors
      ~SphinxInteractive.collect_logfiles
      ~SphinxInteractive.collect_output
      ~SphinxInteractive.collect_structures
      ~SphinxInteractive.collect_warnings
      ~SphinxInteractive.compress
      ~SphinxInteractive.continue_with_final_structure
      ~SphinxInteractive.continue_with_restart_files
      ~SphinxInteractive.convergence_check
      ~SphinxInteractive.copy
      ~SphinxInteractive.copy_file_to_working_directory
      ~SphinxInteractive.copy_template
      ~SphinxInteractive.copy_to
      ~SphinxInteractive.create_job
      ~SphinxInteractive.create_pipeline
      ~SphinxInteractive.db_entry
      ~SphinxInteractive.decompress
      ~SphinxInteractive.drop_status_to_aborted
      ~SphinxInteractive.from_dict
      ~SphinxInteractive.from_directory
      ~SphinxInteractive.from_hdf
      ~SphinxInteractive.from_hdf_args
      ~SphinxInteractive.get
      ~SphinxInteractive.get_bader_charges
      ~SphinxInteractive.get_bader_volumes
      ~SphinxInteractive.get_calculate_function
      ~SphinxInteractive.get_charge_density
      ~SphinxInteractive.get_density_of_states
      ~SphinxInteractive.get_electronic_structure
      ~SphinxInteractive.get_electrostatic_potential
      ~SphinxInteractive.get_encut
      ~SphinxInteractive.get_final_structure
      ~SphinxInteractive.get_from_table
      ~SphinxInteractive.get_input_parameter_dict
      ~SphinxInteractive.get_job_id
      ~SphinxInteractive.get_k_mesh_by_cell
      ~SphinxInteractive.get_kpoints
      ~SphinxInteractive.get_magnetic_moments
      ~SphinxInteractive.get_n_ir_reciprocal_points
      ~SphinxInteractive.get_neighbors
      ~SphinxInteractive.get_neighbors_snapshots
      ~SphinxInteractive.get_output_parameter_dict
      ~SphinxInteractive.get_scf_group
      ~SphinxInteractive.get_structure
      ~SphinxInteractive.get_structure_group
      ~SphinxInteractive.get_valence_and_total_charge_density
      ~SphinxInteractive.get_version_float
      ~SphinxInteractive.get_workdir_file
      ~SphinxInteractive.gui
      ~SphinxInteractive.inspect
      ~SphinxInteractive.instantiate
      ~SphinxInteractive.interactive_atom_spin_constraints_getter
      ~SphinxInteractive.interactive_atom_spins_getter
      ~SphinxInteractive.interactive_cell_organizer
      ~SphinxInteractive.interactive_cells_getter
      ~SphinxInteractive.interactive_cells_setter
      ~SphinxInteractive.interactive_close
      ~SphinxInteractive.interactive_collect
      ~SphinxInteractive.interactive_computation_time_getter
      ~SphinxInteractive.interactive_energy_pot_getter
      ~SphinxInteractive.interactive_energy_tot_getter
      ~SphinxInteractive.interactive_fetch
      ~SphinxInteractive.interactive_flush
      ~SphinxInteractive.interactive_forces_getter
      ~SphinxInteractive.interactive_index_organizer
      ~SphinxInteractive.interactive_indices_getter
      ~SphinxInteractive.interactive_indices_setter
      ~SphinxInteractive.interactive_initialize_interface
      ~SphinxInteractive.interactive_is_activated
      ~SphinxInteractive.interactive_magmom_organizer
      ~SphinxInteractive.interactive_magnetic_forces_getter
      ~SphinxInteractive.interactive_open
      ~SphinxInteractive.interactive_positions_getter
      ~SphinxInteractive.interactive_positions_organizer
      ~SphinxInteractive.interactive_positions_setter
      ~SphinxInteractive.interactive_pressures_getter
      ~SphinxInteractive.interactive_spin_constraints_getter
      ~SphinxInteractive.interactive_spin_constraints_setter
      ~SphinxInteractive.interactive_spins_getter
      ~SphinxInteractive.interactive_steps_getter
      ~SphinxInteractive.interactive_store_in_cache
      ~SphinxInteractive.interactive_stress_getter
      ~SphinxInteractive.interactive_structure_setter
      ~SphinxInteractive.interactive_temperatures_getter
      ~SphinxInteractive.interactive_time_getter
      ~SphinxInteractive.interactive_unwrapped_positions_getter
      ~SphinxInteractive.interactive_volume_getter
      ~SphinxInteractive.is_compressed
      ~SphinxInteractive.is_master_id
      ~SphinxInteractive.is_self_archived
      ~SphinxInteractive.iter_structures
      ~SphinxInteractive.job_file_name
      ~SphinxInteractive.kill
      ~SphinxInteractive.list_all
      ~SphinxInteractive.list_childs
      ~SphinxInteractive.list_files
      ~SphinxInteractive.list_groups
      ~SphinxInteractive.list_nodes
      ~SphinxInteractive.list_potentials
      ~SphinxInteractive.load
      ~SphinxInteractive.load_basis_group
      ~SphinxInteractive.load_default_groups
      ~SphinxInteractive.load_default_input
      ~SphinxInteractive.load_guess_group
      ~SphinxInteractive.load_hamilton_group
      ~SphinxInteractive.load_main_group
      ~SphinxInteractive.load_species_group
      ~SphinxInteractive.load_structure_group
      ~SphinxInteractive.map
      ~SphinxInteractive.modify_kpoints
      ~SphinxInteractive.move_to
      ~SphinxInteractive.nbands_convergence_check
      ~SphinxInteractive.refresh_job_status
      ~SphinxInteractive.relocate_hdf5
      ~SphinxInteractive.remove
      ~SphinxInteractive.remove_and_reset_id
      ~SphinxInteractive.remove_child
      ~SphinxInteractive.rename
      ~SphinxInteractive.reset_job_id
      ~SphinxInteractive.restart
      ~SphinxInteractive.restart_for_band_structure_calculations
      ~SphinxInteractive.restart_from_charge_density
      ~SphinxInteractive.restart_from_wave_functions
      ~SphinxInteractive.run
      ~SphinxInteractive.run_addon
      ~SphinxInteractive.run_if_interactive
      ~SphinxInteractive.run_if_interactive_non_modal
      ~SphinxInteractive.run_if_modal
      ~SphinxInteractive.run_if_refresh
      ~SphinxInteractive.run_if_scheduler
      ~SphinxInteractive.run_static
      ~SphinxInteractive.run_time_to_db
      ~SphinxInteractive.save
      ~SphinxInteractive.save_output
      ~SphinxInteractive.self_archive
      ~SphinxInteractive.self_unarchive
      ~SphinxInteractive.set_check_overlap
      ~SphinxInteractive.set_convergence_precision
      ~SphinxInteractive.set_empty_states
      ~SphinxInteractive.set_encut
      ~SphinxInteractive.set_exchange_correlation_functional
      ~SphinxInteractive.set_input_to_read_only
      ~SphinxInteractive.set_kpoints
      ~SphinxInteractive.set_mixing_parameters
      ~SphinxInteractive.set_occupancy_smearing
      ~SphinxInteractive.show_hdf
      ~SphinxInteractive.signal_intercept
      ~SphinxInteractive.species_from_hdf
      ~SphinxInteractive.store_structure
      ~SphinxInteractive.suspend
      ~SphinxInteractive.to_dict
      ~SphinxInteractive.to_hdf
      ~SphinxInteractive.to_object
      ~SphinxInteractive.trajectory
      ~SphinxInteractive.transfer_from_remote
      ~SphinxInteractive.transform_structures
      ~SphinxInteractive.update_master
      ~SphinxInteractive.update_sphinx
      ~SphinxInteractive.validate_ready_to_run
      ~SphinxInteractive.view_structure
      ~SphinxInteractive.write_input
      ~SphinxInteractive.write_traj
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~SphinxInteractive.calculate_kwargs
      ~SphinxInteractive.child_ids
      ~SphinxInteractive.content
      ~SphinxInteractive.current_structure
      ~SphinxInteractive.database_entry
      ~SphinxInteractive.encut
      ~SphinxInteractive.exchange_correlation_functional
      ~SphinxInteractive.exclude_groups_hdf
      ~SphinxInteractive.exclude_nodes_hdf
      ~SphinxInteractive.executable
      ~SphinxInteractive.executor_type
      ~SphinxInteractive.files
      ~SphinxInteractive.files_to_compress
      ~SphinxInteractive.files_to_remove
      ~SphinxInteractive.fix_spin_constraint
      ~SphinxInteractive.fix_symmetry
      ~SphinxInteractive.id
      ~SphinxInteractive.id_pyi_to_spx
      ~SphinxInteractive.id_spx_to_pyi
      ~SphinxInteractive.initial_structure
      ~SphinxInteractive.interactive_enforce_structure_reset
      ~SphinxInteractive.interactive_flush_frequency
      ~SphinxInteractive.interactive_write_frequency
      ~SphinxInteractive.job_id
      ~SphinxInteractive.job_info_str
      ~SphinxInteractive.job_name
      ~SphinxInteractive.job_type
      ~SphinxInteractive.k_mesh_center_shift
      ~SphinxInteractive.k_mesh_spacing
      ~SphinxInteractive.kpoint_mesh
      ~SphinxInteractive.logger
      ~SphinxInteractive.master_id
      ~SphinxInteractive.name
      ~SphinxInteractive.number_of_structures
      ~SphinxInteractive.parent_id
      ~SphinxInteractive.path
      ~SphinxInteractive.plane_wave_cutoff
      ~SphinxInteractive.potential
      ~SphinxInteractive.potential_list
      ~SphinxInteractive.potential_view
      ~SphinxInteractive.project
      ~SphinxInteractive.project_hdf5
      ~SphinxInteractive.queue_id
      ~SphinxInteractive.reduce_kpoint_symmetry
      ~SphinxInteractive.restart_file_dict
      ~SphinxInteractive.restart_file_list
      ~SphinxInteractive.server
      ~SphinxInteractive.spin_constraints
      ~SphinxInteractive.status
      ~SphinxInteractive.structure
      ~SphinxInteractive.version
      ~SphinxInteractive.working_directory
      ~SphinxInteractive.xc