You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
pip install -e .# For editable install, useful for development work
52
52
```
53
-
54
53
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).
55
54
## How to Cite
56
55
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:
59
58
Causal Testing Framework (paper citation).``
60
59
61
60
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},
To contribute to our work, please ensure the following:
68
108
69
109
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.
70
110
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.
72
112
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.
73
113
74
114
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.
75
115
To find the other (optional) developer dependencies, please check `pyproject.toml`.
76
116
77
117
78
118
79
-
80
119
## Acknowledgements
81
120
82
121
The Causal Testing Framework is supported by the UK's Engineering and Physical Sciences Research Council (EPSRC),
0 commit comments