Skip to content

Commit

Permalink
clarify state of package
Browse files Browse the repository at this point in the history
  • Loading branch information
cgarling committed May 20, 2024
1 parent cbbca53 commit 387c752
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

# StarFormationHistories.jl
This package implements methods for modelling observed color-magnitude diagrams (CMDs) and using them to fit astrophysical star formation histories (SFHs). A paper describing the implemented methodologies is currently in preparation. This package also provides utilities for simulating CMDs given input SFHs and photometric error and completeness functions, which can be useful for planning observations and writing proposals. Please see our documentation (linked in the badge above) for more information. A rendered Jupyter notebook with example usage of this package is available [here](https://nbviewer.org/github/cgarling/StarFormationHistories.jl/blob/main/examples/fitting1.ipynb).
This package implements methods for modelling observed color-magnitude diagrams (CMDs) and using them to fit astrophysical star formation histories (SFHs). A paper describing the implemented methodologies is currently in preparation. This package also provides utilities for simulating CMDs given input SFHs and photometric error and completeness functions, which can be useful for planning observations and writing proposals. Please see our documentation (linked in the badge above) for more information. A rendered Jupyter notebook with example usage of this package is available [here](https://nbviewer.org/github/cgarling/StarFormationHistories.jl/blob/main/examples/fitting1.ipynb).

This package is currently considered pre-release and is not yet registered to the general registry. It will be registered upon completion of the associated journal paper.

## Acknowledgements
Support for this work was provided by the Owens Family Foundation and by NASA through grant HST-AR-17560 from the Space Telescope Science Institute, which is operated by AURA, Inc., under NASA contract NAS5-26555.

0 comments on commit 387c752

Please sign in to comment.