Skip to content
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

Citation feature for population models #46

Closed
scottperkins opened this issue Sep 8, 2024 · 2 comments · Fixed by #66
Closed

Citation feature for population models #46

scottperkins opened this issue Sep 8, 2024 · 2 comments · Fixed by #66
Assignees
Labels
enhancement New feature or request

Comments

@scottperkins
Copy link
Member

We could include a metadata tag in the population files to include a DOI entry, with an added citation() method in population model that prints the DOI for citing specific models.

@scottperkins scottperkins added the enhancement New feature or request label Sep 8, 2024
@astrophpeter
Copy link
Member

Tasks that need to be completed for this:

  1. update asdf model files in /data/ to include a citation field that is a list of strings.
  2. Add relevant citations DOIs, for all three current models are ["10.3847/1538-4357/ab5fd3", "10.3847/1538-4357/aca09d"], to the current asdf files. Probably should read them in add the field and save them, then commit the new model files
  3. update validate_asdf_population_model to include a checks for this field
  4. update all docs and mention this field
  5. add citation (property) method to PopulationModel which returns this list of DOIs for a given model. Add tests to test this functionality. You will also need to modify PopulationModel init and from_asdf and to_asdf to include citations parameters and save/write them. Update tests accordingly.

@astrophpeter
Copy link
Member

Larger one this time @caitlinbegbie :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants