Skip to content

Commit d912ae8

Browse files
committed
update: README.md new sections
1 parent 7d99149 commit d912ae8

File tree

1 file changed

+44
-5
lines changed

1 file changed

+44
-5
lines changed

README.md

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ git checkout tags/<tag> -b <branch>
5050
pip install . # For core API only
5151
pip install -e . # For editable install, useful for development work
5252
```
53-
5453
For more information on how to use the Causal Testing Framework, please refer to our [documentation](https://causal-testing-framework.readthedocs.io/en/latest/?badge=latest).
5554
## How to Cite
5655
If you use our framework in your work, please cite the following:
@@ -59,24 +58,64 @@ If you use our framework in your work, please cite the following:
5958
Causal Testing Framework (paper citation).``
6059

6160
The paper citation should be the Causal Testing Framework [paper](https://dl.acm.org/doi/10.1145/3607184),
62-
and the software citation should be the specific Figshare [DOI](https://orda.shef.ac.uk/articles/software/CITCOM_Software_Release/24427516) of the version used in your work.
63-
61+
and the software citation should contain the specific Figshare [DOI](https://orda.shef.ac.uk/articles/software/CITCOM_Software_Release/24427516) of the version used in your work.
62+
63+
64+
65+
<details>
66+
<summary><b>BibTeX Citations</b></summary>
67+
68+
<details>
69+
<summary>Paper</summary>
70+
71+
```
72+
@ARTICLE{Clark_etal_2023,
73+
author = {Clark, Andrew G. and Foster, Michael and Prifling, Benedikt and Walkinshaw, Neil and Hierons, Robert M.
74+
and Schmidt, Volker and Turner, Robert D.},
75+
title = {Testing Causality in Scientific Modelling Software},
76+
year = {2023},
77+
publisher = {Association for Computing Machinery},
78+
url = {https://doi.org/10.1145/3607184},
79+
doi = {10.1145/3607184},
80+
journal = {ACM Trans. Softw. Eng. Methodol.},
81+
month = {jul},
82+
keywords = {Software Testing, Causal Testing, Causal Inference}
83+
}
84+
```
85+
86+
</details>
87+
88+
<details>
89+
<summary>Software (example)</summary>
90+
91+
```
92+
@ARTICLE{Wild2023,
93+
author = {Wild, Christopher and Foster, Michael and Walkinshaw, Neil and Clark, Andrew G. and Allian, Farhad and Somers, Richard},
94+
title = {CITCOM Software Release},
95+
year = {2023},
96+
month = {nov},
97+
url = {https://orda.shef.ac.uk/articles/software/CITCOM_Software_Release/24427516},
98+
doi = {10.15131/shef.data.24427516.v1}
99+
}
100+
```
101+
</details>
102+
103+
</details>
64104

65105
## How to Contribute
66106

67107
To contribute to our work, please ensure the following:
68108

69109
1. [Fork the repository](https://help.github.com/articles/fork-a-repo/) into your own GitHub account, and [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it to your local machine.
70110
2. [Create a new branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) in your forked repository. Give this branch an appropriate name, and create commits that describe the changes.
71-
3. [Push your changes](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository) to your new branch in your remote fork, compare with `CausalTestingFramework/main`, and ensure conflicts are resolved as necessary.
111+
3. [Push your changes](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository) to your new branch in your remote fork, compare with `CausalTestingFramework/main`, and ensure any conflicts are resolved.
72112
4. Create a draft [pull request](https://docs.github.com/en/get-started/quickstart/hello-world#opening-a-pull-request) from your branch, and ensure you have [linked](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls) it to any relevant issues in your description.
73113

74114
We use the [pytest](https://pytest.org/en/latest/) framework as our testing suite, [pylint](https://pypi.org/project/pylint/) for our code analyser, and [black](https://pypi.org/project/black/) for our code formatting.
75115
To find the other (optional) developer dependencies, please check `pyproject.toml`.
76116

77117

78118

79-
80119
## Acknowledgements
81120

82121
The Causal Testing Framework is supported by the UK's Engineering and Physical Sciences Research Council (EPSRC),

0 commit comments

Comments
 (0)