Skip to content

Commit eff371b

Browse files
committed
update: README.md sections
1 parent 66bbe26 commit eff371b

File tree

1 file changed

+41
-4
lines changed

1 file changed

+41
-4
lines changed

README.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,46 @@ system-under-test that is expected to cause a change to some output(s).
2323

2424
## Installation
2525

26-
See the Read the Docs site for [installation
27-
instructions](https://causal-testing-framework.readthedocs.io/en/latest/installation.html).
26+
### Requirements
27+
- Python >= 3.9.
2828

29-
## Documentation
29+
- Microsoft Visual C++ 14.0+ (Windows only).
3030

31-
Further information on causal inference, the code, usage and more can be found on the [docs](https://causal-testing-framework.readthedocs.io/en/latest/)
31+
To install the latest stable release of the Causal Testing Framework:
32+
33+
``pip install causal-testing-framework``
34+
35+
or if you want to install with the development packages/tools:
36+
37+
``pip install causal-testing-framework[dev]``
38+
39+
Alternatively, you can install directly via source:
40+
41+
```shell
42+
git clone https://github.com/CITCOM-project/CausalTestingFramework
43+
cd CausalTestingFramework
44+
```
45+
then to install a specific release:
46+
47+
```shell
48+
git fetch --all --tags --prune
49+
git checkout tags/<tag> -b <branch>
50+
pip install . # For core API only
51+
pip install -e . # For editable install, useful for development work
52+
```
53+
54+
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+
## How to Cite
56+
If you use our framework in your work, please cite the following:
57+
58+
``This research has used version X.Y.Z (software citation) of the
59+
Causal Testing Framework (paper citation).``
60+
61+
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+
64+
## Acknowledgements
65+
66+
The Causal Testing Framework is supported by the UK's Engineering and Physical Sciences Research Council (EPSRC),
67+
with the project name [CITCOM](https://gow.epsrc.ukri.org/NGBOViewGrant.aspx?GrantRef=EP/T030526/1) - "_Causal Inference for Testing of Computational Models_"
68+
under the grant EP/T030526/1.

0 commit comments

Comments
 (0)