Skip to content
Snippets Groups Projects
Commit b6bde8a0 authored by Guido Sterbini's avatar Guido Sterbini
Browse files

Filling the README

parent 5ca31095
No related branches found
No related tags found
No related merge requests found
Pipeline #2723128 failed
HELLOHELLO
# tree_maker
## Introduction
A beam phycisist (BP) should be as close as possible to the physics of the beam.
Parametric scans of numerical models flourished thanks to the availability
of unprecedented computing power and the lack, the limit or complexity of the analytical tools.
The focus of the BP should not be technicalities of the numerical simulations.
This package aims to contribute in relieve the BP from this unnecessary burden.
The "job" is the atomic unit of the simulation step and it contains all the relevant physics.
As such, **the BP should harness it**.
A "job" ultimately is a code running on a standalone pc.
The BP can launch several "children" jobs almost identical to the "parent" job with the exception of one or more "mutations".
This set of children jobs can be referred as a "generation".
E.g., from a given and initial "pymask" job with tune (.31,.32) we want to generate a tune scan grid of 10x10 jobs with differen tunes (a tune scan).
This is a "generation".
Each jobs can be "parent" of other jobs thus propagating a second generation.
The jobs can be run in parallel, locally or remotely.
There are different phases:
- define the template job.
- apply a cloning
- apply one or more mutations
- running the job.
The `tree` information is a "map" (e.g., a dictionary, a yaml file, a pandas dataframe) we use to define to describe the parent folder, children folders and mutations.
This package is intended to create the corresponding folders of the "generations" of the BP's study. The goal is to ease the BP's activity **but** maintain him in close contact with the "parent" job (see above, **the BP should harness it**) and offer an adequate flexibility.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment