tardis-sn / tardis

TARDIS - Temperature And Radiative Diffusion In Supernovae
https://tardis-sn.github.io/tardis
202 stars 404 forks source link

Clean up custom abundance input and documentation #1417

Open andrewfullard opened 3 years ago

andrewfullard commented 3 years ago

Problem description

Currently the two custom input options are in the documentation "ascii" and "csv". Neither are truly descriptive of the file types used or the formatting requirements.

I propose changing the "ascii" input type to be "complex_composition" (because it requires all isotopes from Z=0-30) and the "csv" input type to be "simple_composition" because it requires only isotope names in the header. The user should be able to choose a delimiter for either input file type as part of the configuration.

This would involve changes primarily to tardis/io/model_reader.py and the model input schema.

DhruvSondhi commented 3 years ago

Hello, I wish to work on the same with some guidance for the exact changes that are needed to reach the required goal :) I do understand that we need to keep one type of the file format specifically for complex_composition & the other one for simple_composition but how can it be elaborated in the documentation is a matter of concern 🤔

andrewfullard commented 3 years ago

I would recommend providing examples following the existing documentation style for custom compositions

karban8 commented 3 years ago

Hi, I would like to take up this issue. After going through the documentation i got to know that the 'ascii' input files use a ‘.dat’ format and csv input files use a ‘.csv’ format.Our objective is to change ‘ascii’ input type to ‘complex_composition’ and ‘csv’ to ‘simple_composition’.Going through the model_reader.py file i saw many funtions like ‘read_simple_ascii_abundance’ in which i need to make changes to the input names. Please tell if i am thinking in the right direction and do elaborate on what all should be done.

andrewfullard commented 3 years ago

That's correct @karban8