search

zemogle / chemevol

Chemical evolution python package
3 stars 3 forks source link

readme

ChemEvol

Build Status

Python package to read in a star formation history file, input galaxy parameters and run a chemical evolution model to determine the evolution of gas, metals and dust in galaxies.

Running the script following the instructions below will produce:

  1. a results data file with galaxy parameters in (filename.dat with name provided by user from inits file - see instructions below)

The code is based on Morgan & Edmunds 2003 (MNRAS, 343, 427) and described in detail in Rowlands et al 2014 (MNRAS, 441, 1040), and De Vis et al 2017b (MNRAS, 471, 1743), with the latest developments described in De Vis et al 2021 .

The version of this code used for De Vis et al 2017b is in release v_de_vis2017. The master version contains the version described in De Vis et al 2021.

# If you use this code, please do cite the above papers. The license is provided with this package.

Installation

Download this repository and do the following:

python setup.py install

Requirements

Python packages

Input files needed

The code reads in a star formation history or star formation efficiency file from a file called filename.sfh or filename.sfe respectively. This needs to be in the form: time (yr), SFR/SFE (Msolar/yr), inflow rates (Msolar/yr) and in the directory where you are running the code. Examples are provided with this code in the examples directory, e.g. Milkyway.sfh based on the SFH for the Milky Way in Yin et al 2009 (A & A, 505, 497) or any of the other .sfh and .sfe files (described in De Vis et al 2017,2020).

Input data needed

The code also requires a dictionary of initial parameters. This can be done by providing a .json or .csv file and using the package installed, or by running the example python script provided with this package.

There are example data files in the folder <Download Dir>/chemevol/chemevol/examples/ which show the correct format of each type of file. Feel free to copy these example data files into the directory where you wish to run the code and follow the instructions. A detailed breakdown of the parameter files and inputs needed are found at the bottom of this readme. The most basic example of using the chemevol package would be:

from chemevol import ChemModel
ch = ChemModel(**item)
snrate = ch.supernova_rate()
all_results = ch.gas_metal_dust_mass(snrate)

There are helper functions for loading batch files in CSV and valid JSON format. Note: Valid JSON uses double quotes for definitions and lower case for booleans, e.g. "myvalue" : false

Running the code as a package using json or csv data files

import chemevol as ch
galaxies = ch.BulkEvolve('<File directory>/data.json')
galaxies.upload_json()
galaxies.evolve_all()

Or for CSV files:

import chemevol as ch
galaxies = ch.BulkEvolve('data.csv')
galaxies.upload_csv()
galaxies.evolve_all()

See the files in <Download Dir>/chemevol/chemevol/examples/ for the correct format of each type of file (.py, .json, .csv examples are provided).

Viewing the results

Once the code is run you will have an array called galaxies.results with all the parameters in. To look at this data try:

[g['dust_all'] for g in galaxies.results] #will print out the dust_all ( which is the total dust mass that was produced, without taking into account any dust destruction).
[g['mgas'] for g in galaxies.results] #will print out all the gas masses
gasmass  = galaxies.results[0]['mgas'] #etc

The code writes data to a file (if you use the example in <Download Dir>/chemevol/chemevol/examples/data.json the code writes out two files called Model_A.dat and Model_B.dat). To read in this data for plotting or playing with you can use astropy.table:

from astropy.table import Table
import matplotlib.pyplot as plt

t = Table.read('Model_A.dat', format='ascii')
plt.semilogy(t['fg'],t['dustmass']/(t['mgas']+t['mstars']))

Alternatively you can run the code without the bulkevolve class above:

What follows is a short description of the various scripts in the chemevol package and their general usage.

lookups.py, functions.py and evolve.py form the core of the chemevol package. lookups.py contains the bulk of the hardcoded tables, such as the metal yield tables etc. When one wants to add different yield tables, these have to included in lookups.py in the appropriate format.

functions.py contains various functions that give numerical descriptions of the various formula used throughout the model calculations. E.g. it contains all the dust processing mechanisms or the prescription for how the inflows/outflows and recycling is handled.

evolve.py runs the actual model, by keeping track of the gas, dust and metal content through each time-step as a result of all the ongoing physical processes. To run a model, the appropriate inputs have to be defined and passed as a dictionary to the initialiser of the ChemModel class.

Next to these core files, there are some script in the examples directory that automate some of the setup and running of the chemical evolution models. These call to the chemevol package and provide the easiest way to run one or more models.

example_multi.py gives some example input dictionaries, as well as the appropriate way to process them with the chemevol package and write the output data to .dat or .csv files. Copy the example_multi.py file to the desired directory (where your .sfh file is and where you want to have your results). Then edit the parameters in the init dictionaries within this script.

run_grid_parallel.py reads input parameters from a predefined csv file and processes them in parallel. This script has all the functionallity to efficiently run and save a large amount of models.

make_gridTable_dust.py creates the csv file for a grid of models, typically processed by run_grid_parallel.py.

make_sfe_sfh.py shows how to create SFE/SFH files with some examples. Any changes to the star formation history or the inflow rates will be made here.

There is also a log file that lists the warnings. These are warnings about corrections made during the model calculations. Actual errors or failures of the code will still cause the code to crash and give an appropriate error message.

.sfe star formation efficiency files, as defined in De Vis et al. (2020) .sfh star formation history files, as defined in De Vis et al. (2017) **.dat some example models

Full list of Input Parameters to Model