From 39e276ca967a9e4a54fbed65c7d194e0dacb764f Mon Sep 17 00:00:00 2001 From: Chris Garling Date: Sat, 1 Jun 2024 09:02:42 -0400 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 41f8c8d..0627b2e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ +StarFormationHistories.jl +================ + [![Build Status](https://github.com/cgarling/StarFormationHistories.jl/workflows/CI/badge.svg)](https://github.com/cgarling/InitialMassFunctions.jl/actions) [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://cgarling.github.io/StarFormationHistories.jl/dev/) [![codecov](https://codecov.io/github/cgarling/StarFormationHistories.jl/graph/badge.svg?token=L69R23H29M)](https://codecov.io/github/cgarling/StarFormationHistories.jl) [![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 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.