Skip to content

Clean up custom abundance input and documentation #1417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andrewfullard opened this issue Jan 21, 2021 · 4 comments
Open

Clean up custom abundance input and documentation #1417

andrewfullard opened this issue Jan 21, 2021 · 4 comments

Comments

@andrewfullard
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor Author

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

@karban8
Copy link

karban8 commented Mar 20, 2021

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
Copy link
Contributor Author

That's correct @karban8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants