CosmoSim Scripts

User tools¶

CosmoSim is a suite of tools. The page below document the main command line utilities. In addition, we have the following:

• CosmoSim GUI

• The droulette package (not yet published)

• Additional documentation which is out of date

  • datagen script

  • Roulette Resimulation Scripts

See also CosmoSim demos.

CosmoSim on the Command Line¶

The CosmoSim module is executable (as of version 3.0.0), providing several modes of operation.

• python -m CosmoSim --version shows version information and exits.

• python -m CosmoSim --rnd --toml infile --csvfile outfile ... does bulk simulation, generating random parameters based on the specification in the infile.

• python -m CosmoSim --csvfile fn ... (without --rnd) does bulk simulation using the given set of parameters.

• python -m CosmoSim --roulette fn ... does roulette resimulation using amplitudes from the given file.

The dataset generation (rnd) can also be accessed separately:

• CosmoSim.dataset

  • random generation of parameters for data sets

  • the output is a CSV file to be read by datagen.py

  • TODO further documentation

• In version 2.x, the main functionality was split between two scripts

  • CosmoSim.datagen is the main CLI tool

    • bulk generation of images

  • CosmoSim.roulettegen Roulette Resimulation Scripts

    • generate images from a set of roulette amplitudes

Other scripts¶

• compare.py

  • Quantitatively compare two batches of images, intended for regression testing.

• python -m CosmoSim.Roulettes

  • Generate a file with roulette amplitudes for the SIS and pointmass lensese.

  • For development use only

  • The generated files are included in the release packages and found by the library.

  • python -m CosmoSim.Roulettes.sie for the SIE lens

Source Models Supported¶

The following names should be used to specify the source. Other names are defined, but will be deprecated.

• "Spherical" : Gaussian light distribution

• "Ellipsoid" : Ellipsoid source with Gaussian distribution

• "SersicSphere" : Spherical Source with Sersic profile

• "SersicEllipsoid" : Ellipsoid source with Sersic profile

• "Triangle" - a coloured triangle, for better visualisation of distortion effects

• "Image (Einstein)" - a portrait of Einstein, for fun

Lens and Simulation Models Supported¶

The display names are used in the GUI and should be used whereever spaces do not confuse the parser. The alias can be used in data files where space may cause problems.