Welcome to Simultipac’s documentation!

LightWin

• Introduction
• Jupyter notebook examples
  • Compute exponential growth from SPARK3D
  • Compute exponential growth from CST
  • Particle Monitor: WR75 study case
  • Particle Monitor: TESLA study case
• API Reference
  • cst package
    • helper module
    • simulation_results module
  • particle_monitor package
    • collisions package
      • util module
      • vedo_mesh_collisions module
    • converters module
    • particle module
    • particle_monitor module
    • vector module
  • plotter package
    • default module
    • plotter module
  • simulation_results package
    • simulation_results module
    • simulations_results module
  • spark3d package
    • simulation_results module
  • util package
    • exponential_growth module
    • log_manager module
    • singleton module
  • constants module
  • types module

Todo

Detect integer values.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/cst/helper.py:docstring of simultipac.cst.helper._parameters_file_to_dict, line 3.)

Todo

Evaluate simple expressions. A parameter defined as ‘1/2’ will be a string instead of 0.5 (float)…

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/cst/helper.py:docstring of simultipac.cst.helper._parameters_file_to_dict, line 6.)

Todo

Evaluate expressions such as param2 = 2 * param1

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/cst/simulation_results.py:docstring of simultipac.cst.simulation_results, line 8.)

Todo

Allow to have P_rms instead of E_acc; E_acc does not make a lot of sense in a lot of cases.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/cst/simulation_results.py:docstring of simultipac.cst.simulation_results, line 11.)

Todo

Take only nearest cell instead of the one with the lowest ID as for now.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/particle_monitor/particle.py:docstring of simultipac.particle_monitor.particle.Particle.find_collision, line 15.)

Todo

Raise error when folder is not found.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/particle_monitor/particle_monitor.py:docstring of simultipac.particle_monitor.particle_monitor, line 6.)

Todo

Type hints could be cleaner.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/particle_monitor/particle_monitor.py:docstring of simultipac.particle_monitor.particle_monitor._load_particle_monitor_file, line 6.)

Todo

Why did I choose to compute position difference rather than just taking the momentum array when not normalizing???

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/particle_monitor/particle_monitor.py:docstring of simultipac.particle_monitor.particle_monitor.ParticleMonitor.last_known_direction, line 3.)

Todo

Check is position is normalized or not.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/particle_monitor/vector.py:docstring of simultipac.particle_monitor.vector.Position.extrapolate, line 7.)

Todo

Review this and its error handling

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/simulation_results/simulations_results.py:docstring of simultipac.simulation_results.simulations_results.SimulationsResults._to_pandas, line 3.)

Todo

Handle malformed files. In particular what happens if simulation numbers are mixed?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/spark3d/simulation_results.py:docstring of simultipac.spark3d.simulation_results.Spark3DResultsFactory._from_txt, line 16.)

Todo

Move exp_growth module?

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/util/__init__.py:docstring of simultipac.util, line 3.)

Todo

Better unit testing for this function.

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/util/exponential_growth.py:docstring of simultipac.util.exponential_growth._smoothen, line 8.)

Todo

Will look for the script commit number, not for the code commit number!

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/simultipac/envs/latest/lib/python3.12/site-packages/simultipac/util/log_manager.py:docstring of simultipac.util.log_manager._get_last_commit_hash, line 5.)

Indices and tables

• Index

• Module Index

• Search Page