Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 2.68 KB

.pip_readme.md

File metadata and controls

79 lines (59 loc) · 2.68 KB

image image All Contributors image

Scattering based cosmic string emulation

stringgen is a tool for creating emulations of cosmic string maps with similar statistics to based on the works in Price et al. 2022 (in prep.). It uses wavelet phase harmonics to calculate scattering coefficients of the simulations. These coefficients can then be used to synthesize new realisations which have similar statistics to the original simulations.

Quick install 💻

You can install stringgen using PyPi by running

pip install stringgen

Install from source 💻

Alternative you can install the code from source by cloning and installing manually:

git clone https://github.com/astro-informatics/stringgen.git
cd cosmic_string_emulator
bash build_stringgen.sh

Usage 🚀

To generate your own cosmic string maps stringgen is as simple follows:

from stringgen import string_emulator

# Load latent data-bank
features = string_emulator.get_features()

# Generate n_emulation=1 synthetic cosmic string maps
emulation = emulator.emulate(features, n_emulations=1)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Attribution 📚

Should this code be used in any way, we kindly request that the following article is referenced. A BibTeX entry for this reference may look like:

@article{price:stringgen, 
   AUTHOR      = "Matthew A. Price and Matthijs Mars and Jason D. McEwen and Contributors",
   TITLE       = "TBA",
   YEAR        = "2023",
   EPRINT      = "arXiv:0000.00000"        
}

License 📝

We provide this code under an MIT open-source licence with the hope that it will be of use to a wider community.

Copyright 2023 Mattijs Mars, Matthew Price, Jason McEwen and contributors.

stringgen is free software made available under the MIT License. For details see the LICENSE file.