Documentation #1014

Envelope task #966: === Theory & Manual ===

Manual: describe simulation with distributed parameters

Added by pospelov over 4 years ago. Updated about 3 years ago.

Status:BacklogStart date:19 Mar 2015
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:-
Target version:-

Description

  • We need a chapter which explains in details how to run the simulation with distributed parameters from PythonAPI and GUI
    • where beam divergence is one possible application
    • particles with size distribution is another
  • it has to cover following classes and methods
    • DistributionGate, DistributionLorentz, DistributionGaussian, DistributionLogNormal, DistributionCosine
    • ParameterDistribution, Simulation::addParameterDistribution
  • explains things like nbr_samples, sigma_factor, AttLimits
  • should contains nice graph showing distribution and their sampling
  • It has to be on Drupal in the form of tutorials in two places:
    • /documentation/usage/scripting and then "Simulation with distributed parameters"
    • /documentation/usage/detailed GUI usage
  • Also take care about InterfereceFunction2DSummOfRotated
    • it is usefull example, but somehow it is confusing, that for simple rotation sum we use artillery ba.DistributionGate instead of numpy.linspace

History

#1 Updated by pospelov over 4 years ago

  • Description updated (diff)
  • Status changed from New to Sprint
  • Target version set to Sprint 27

#2 Updated by pospelov over 4 years ago

  • Assignee set to pospelov

#3 Updated by pospelov over 4 years ago

  • Status changed from Sprint to Backlog
  • Target version deleted (Sprint 27)

#4 Updated by pospelov over 4 years ago

  • Target version set to Sprint 28

#5 Updated by pospelov over 4 years ago

  • Subject changed from Provide description of the simulation with distributed parameters to Drupal: describe simulation with distributed parameters
  • Status changed from Backlog to Sprint

#6 Updated by pospelov over 4 years ago

  • Status changed from Sprint to Backlog
  • Assignee deleted (pospelov)
  • Target version deleted (Sprint 28)

#7 Updated by pospelov over 4 years ago

  • Status changed from Backlog to Sprint
  • Target version set to Sprint 29

#8 Updated by pospelov about 4 years ago

  • Target version changed from Sprint 29 to Sprint 30

#9 Updated by pospelov almost 4 years ago

  • Status changed from Sprint to Backlog
  • Target version deleted (Sprint 30)

#10 Updated by pospelov over 3 years ago

  • Description updated (diff)
  • Status changed from Backlog to Sprint
  • Target version set to Sprint32

Basing on experience learned from GISAS school, we need this tutorial soon. It is hard to explain the concept of "Simulation with distributed parameters" by jumping between 5 related python examples.

#11 Updated by wuttke about 3 years ago

  • Subject changed from Drupal: describe simulation with distributed parameters to Manual: describe simulation with distributed parameters
  • Parent task changed from #861 to #1606

#12 Updated by pospelov about 3 years ago

  • Status changed from Sprint to Backlog
  • Target version deleted (Sprint32)

#13 Updated by wuttke about 3 years ago

  • Parent task changed from #1606 to #966

Also available in: Atom PDF