Skip to content

Commit 947ac76

Browse files
committed
fix: updated docs
1 parent 81abffb commit 947ac76

3 files changed

Lines changed: 58 additions & 6 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ git checkout tags/<tag> -b <branch>
7676
pip install . # For core API only
7777
pip install -e . # For editable install, useful for development work
7878
```
79-
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).
79+
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). If you have any questions, you can also reach us by [email](citcom-group@sheffield.ac.uk).
8080

8181
>[!NOTE]
8282
>We recommend you use a 64-bit OS (standard in most modern machines) as we have had reports of the installation crashing on legacy 32-bit Debian systems.
@@ -89,12 +89,12 @@ For more information on how to use the Causal Testing Framework, please refer to
8989

9090
2. If you do not already have causal test cases, you can convert your causal DAG to causal tests by running the following command.
9191
```
92-
python -m causal_testing generate --dag_path $PATH_TO_DAG --output_path $PATH_TO_TESTS
92+
python -m causal_testing generate --dag-path $PATH_TO_DAG --output $PATH_TO_TESTS
9393
```
9494

9595
3. You can now execute your tests by running the following command.
9696
```
97-
python -m causal_testing test --dag_path $PATH_TO_DAG --data_paths $PATH_TO_DATA --test_config $PATH_TO_TESTS --output $OUTPUT
97+
python -m causal_testing test --dag-path $PATH_TO_DAG --data-paths $PATH_TO_DATA --test-config $PATH_TO_TESTS --output $OUTPUT
9898
```
9999
The results will be saved for inspection in a JSON file located at `$OUTPUT`.
100100
In the future, we hope to add a visualisation tool to assist with this.

docs/source/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ the inputs and outputs of the system under test, supported by mathematical found
1919
enable causal inference. Each causal test case targets the causal effect of a specific intervention on the system under test--that is,
2020
a deliberate modification to the input configuration expected to produce a corresponding change in one or more outputs.
2121

22+
If you have any questions about our framework, you can also reach us by [email](citcom-group@sheffield.ac.uk).
23+
2224
.. toctree::
2325
:hidden:
2426
:caption: Home
@@ -72,8 +74,9 @@ a deliberate modification to the input configuration expected to produce a corre
7274

7375
CITCoM Homepage <https://sites.google.com/sheffield.ac.uk/citcom/home>
7476
Paper <https://dl.acm.org/doi/10.1145/3607184>
75-
Figshare <https://orda.shef.ac.uk/articles/software/CITCOM_Software_Release/24427516>
7677
PyPI <https://pypi.org/project/causal-testing-framework/>
78+
Conda-forge <https://anaconda.org/channels/conda-forge/packages/causal-testing-framework/overview>
79+
Figshare <https://orda.shef.ac.uk/articles/software/CITCOM_Software_Release/24427516>
7780
DeepWiki <https://deepwiki.com/CITCOM-project/CausalTestingFramework>
7881

7982
.. toctree::

docs/source/installation.rst

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,55 @@ Next Steps
9393

9494
* Check out the :doc:`tutorials` to learn how to use the framework.
9595
* Read about :doc:`modules/causal_specification` to understand causal specifications and :doc:`modules/causal_testing` for the end-to-end causal testing process.
96-
* Try the command-line interface for quick and simple testing::
96+
* Run the command for guidance on how to generate your causal tests directly from your input DAG::
9797

98-
python -m causal_testing test --help
98+
python -m causal_testing generate --help
99+
100+
* and the command on guidance on how to execute your causal tests::
101+
102+
python -m causal_testing test --help
103+
104+
105+
Using the CTF on DAFNI
106+
======================
107+
108+
The Causal Testing Framework is also available to run on `DAFNI <https://www.dafni.ac.uk/>`_, allowing you to generate causal tests and evaluate causal effects from your input data and DAGs without installing the framework locally. This lets you integrate CTF into workflows with other models or datasets easily.
109+
110+
Data tab
111+
--------
112+
113+
- Upload the required input files as a dataset. Typically, this includes:
114+
115+
- ``dag.dot`` – the directed acyclic graph defining causal relationships between variables.
116+
- ``runtime_data.csv`` – the CSV file containing runtime input data.
117+
- ``causal_tests.json`` – optional; if provided, the framework will run tests directly. Otherwise, tests will be generated automatically.
118+
119+
**Note:** Input files must remain in the ``data/inputs`` structure; this is required by the workflow.
120+
121+
Workflow tab
122+
-------------
123+
124+
- Select the CTF workflow.
125+
- In the Parameter sets section, click **Create**.
126+
- In the page that opens:
127+
128+
- Select the model in the workflow (typically ``causal-testing-framework``).
129+
- Complete the sections at the bottom:
130+
131+
- **Parameters:** Set or confirm environment variables from the ``.env`` file (e.g., ``EXECUTION_MODE``, ``CAUSAL_TESTS``, ``CAUSAL_TEST_RESULTS``). These control whether tests are generated or executed, the filenames, estimator, effect type, and other runtime options.
132+
- **Datasets:** Click the icon and select the dataset containing your input files (``dag.dot``, ``runtime_data.csv``, ``causal_tests.json``). All input files will be placed in the required ``data/inputs`` directory when running the workflow.
133+
134+
- Unselect the model if needed, click **Continue**, and complete any required metadata such as the name of the parameter set.
135+
136+
Execute the workflow
137+
----------------------
138+
139+
- Click **Execute workflow with parameter set**.
140+
- If successful, the workflow will either generate ``causal_tests.json`` (if not provided) or run the tests and create ``causal_test_results.json`` in ``data/outputs``.
141+
- After completion, you can view the results in the **Data tab** as a new output dataset.
142+
143+
Customisation and chaining
144+
--------------------------
145+
146+
- You can create additional workflows to customise input parameters, filenames, or estimators.
147+
- Multiple CTF workflows can also be chained to run sequential analyses or to integrate with other models and datasets, combining results for more complex causal testing scenarios.

0 commit comments

Comments
 (0)