Skip to content

Commit

Permalink
Adding citation file
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Li <adam2392@gmail.com>
  • Loading branch information
adam2392 committed Jul 26, 2023
1 parent d995845 commit 297fc1d
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# YAML 1.2
---
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/)
cff-version: 1.2.0
title: 'Pywhy-Stats: Statistical inference in Python.'
abstract: 'Pywhy-Stats is a Python library that leverages a simple API for performing independence and conditional independence testing.'
authors:
- given-names: Adam
family-names: Li
affiliation: 'Department of Computer Science, Columbia University, New York, NY, USA'
orcid: 'https://orcid.org/0000-0001-8421-365X'
- given-names: Patrick
family-names: Blöbaum
affiliation: 'Amazon'
email: 'bloebp@amazon.com'
type: software
repository-code: 'https://github.com/py-why/pywhy-stats'
license: MIT
keywords:
- causality
- pywhy
- statistics
- independece testing
...
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ When you're ready to contribute code to address an open issue, please follow the

</details>

5. Adding your name to the CITATION.cff file

We are a community-driven open-source project and want to make sure all contributors are acknowledged. If you are a new contributor, add your name
to the ``CITATION.cff`` file and relevant metadata.

### Writing docstrings

We use [Sphinx](https://www.sphinx-doc.org/en/master/index.html) to build our API docs, which automatically parses all docstrings
Expand Down

0 comments on commit 297fc1d

Please sign in to comment.