Sulfur Simulation Documentation

This is a Python package designed to simplify the analysis of sulfur spin-echo data.

sulfur_simulation

• sulfur_simulation package
  • SULFUR_IS_COOL
  • Submodules
  • sulfur_simulation.cache module
    • CachedFunction
      • CachedFunction.call_cached()
      • CachedFunction.call_uncached()
      • CachedFunction.load_or_call_cached()
      • CachedFunction.load_or_call_uncached()
    • cached()
    • timed()
  • sulfur_simulation.hopping_calculator module
    • BaseRate
      • BaseRate.grid
    • BaseRateHoppingCalculator
      • BaseRateHoppingCalculator.get_hopping_probabilities()
      • BaseRateHoppingCalculator.normalized_directions
    • HexagonalBaseRate
      • HexagonalBaseRate.grid
      • HexagonalBaseRate.rate
    • HoppingCalculator
      • HoppingCalculator.get_hopping_probabilities()
    • InteractingHoppingCalculator
    • LineDefectHoppingCalculator
    • SquareBaseRate
      • SquareBaseRate.diagonal_rate
      • SquareBaseRate.grid
      • SquareBaseRate.straight_rate
    • get_lennard_jones_potential()
  • sulfur_simulation.isf module
    • ISFParameters
      • ISFParameters.delta_k_array
      • ISFParameters.delta_k_max
      • ISFParameters.form_factor
      • ISFParameters.n_delta_k
      • ISFParameters.params
    • get_all_amplitudes()
    • get_amplitudes()
    • get_dephasing_rates()
    • plot_dephasing_rates()
    • plot_isf()
  • sulfur_simulation.scattering_calculation module
    • SimulationParameters
      • SimulationParameters.hopping_calculator
      • SimulationParameters.initial_positions
      • SimulationParameters.lattice_dimension
      • SimulationParameters.n_particles
      • SimulationParameters.n_timesteps
      • SimulationParameters.times
    • SimulationResult
      • SimulationResult.attempted_jump_counter
      • SimulationResult.jump_count
      • SimulationResult.positions
    • run_simulation()
  • sulfur_simulation.show_simulation module
    • animate_particle_positions()
    • get_timeframe_str()
    • plot_mean_jump_rates()
  • sulfur_simulation.util module
    • get_figure()