Merge pull request #3 from khider/info

information about the repository

CITATION.cff

@@ -0,0 +1,12 @@
+cff-version: 1.0.0
+message: "If you use this Book, please cite it as below."
+authors:
+  - family-names: Khider
+    given-names: Deborah
+    orcid: https://orcid.org/0000-0001-7501-8430
+    affiliation: University of Southern California
+title: "Coral Sr/Ca Calibration - An example from Dry Tortuga's" 
+url: "https://github.com/khider/dry-tortugas-calibration-fun/tree/info"
+version: v1.0.0
+date-released: 2024-09-06
+

README.md

@@ -1,4 +1,38 @@
-# Coral Sr/Ca calibration - Dry Tortugas
+[![PyPI](https://img.shields.io/badge/python-3.11-yellow.svg)]()
+[![license](https://img.shields.io/github/license/khider/dry-tortugas-calibration-fun.svg)]()
 
 
-Replicates the Sr/Ca calibration of DeLong et al. 2011
+# Coral Sr/Ca calibration - An example from Dry Tortugas
+
+
+This Jupyter Book covers the calibration of coral Sr/Ca to sea surface temperature using data from Dry Tortugas (DeLong et al., 2011). The book illustrates the frequentist and Bayesian approach to the task. 
+
+## Author
+
+[Deborah Khider](https://github.com/khider)
+
+## Contributor
+
+<a href="https://github.com/khider/dry-tortugas-calibration-fun/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=khider/dry-tortugas-calibration-fun" />
+</a>
+
+## Structure
+
+This Book is broken down into three chapters:
+- Data exploration of the Sr/Ca data from three cores and nearby sea surface temperature data
+- Calibration uses ordinary and weighted least square regression
+- Bayesian calibration presents a Bayesian alternative to OLS. 
+
+## Data Reference
+DeLong, K.L., J.A. Flannery, C.R. Maupin, R.Z. Poore, and T.M. Quinn. 2011. A coral Sr/Ca calibration and replication study of two massive corals from the Gulf of Mexico. Palaeogeography, Palaeoclimatology, Palaeoecology, 307(1-4), 117-128. doi: 10.1016/j.palaeo.2011.05.005
+
+Dataset citation: DeLong, K.L.; Flannery, J.A.; Maupin, C.R.; Poore, R.Z.; Quinn, T.M. (2011-09-14): NOAA/WDS Paleoclimatology - Dry Tortugas Siderastrea and Montastraea Coral Sr/Ca Data, 1992-2008. [indicate subset used]. NOAA National Centers for Environmental Information. https://doi.org/10.25921/n674-8145. Accessed 2024-09-05. 
+
+## License
+
+All notebooks herein are provided under an [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license.
+
+## Citation
+
+We needn't tell you that making research tools accessible requires time and effort. If you find any of these resources useful and use them in your own research, please do us the kindness of one or more citations. Notebooks in this collection are registered on Zenodo, and associated with a digital object identifier (DOI).  A ready-to-use citation is provided in this GitHub repository in APA and BibTex (in the About section on the right panel, click on "Cite this repository"). If you use Pyleoclim, please cite them as well. It will make us (and NSF!) very happy to hear that these investments spawned more research.

environment.yml

@@ -0,0 +1,13 @@
+# Development environment. This environment includes all the required
+# packages for this repo including running the test suite.
+name: srca
+channels:
+  - default
+  - conda-forge
+dependencies:
+  - python=3.11.0
+  - pymc
+  - numba
+  - pip
+  - pip:
+    - pyleoclim