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
@@ -27,22 +28,47 @@ a deliberate modification to the input configuration expected to produce a corre
27
28
### Requirements
28
29
- Python 3.10, 3.11, 3.12 and 3.13
29
30
30
-
To install the latest stable release of the Causal Testing Framework:
31
+
### Recommended: Install from conda-forge
32
+
33
+
**We recommend using conda or mamba for installation**, as they provide better dependency management and environment isolation, particularly for scientific computing workflows.
34
+
35
+
First, create a new conda environment with a supported Python version, e.g:
36
+
```shell
37
+
conda create -n causal-testing-env python=3.13
38
+
conda activate causal-testing-env
39
+
```
40
+
41
+
> **Note:** If you have [Miniforge](https://conda-forge.org/download/) installed, you can replace `conda` with `mamba` in any of the commands below for faster package resolution.
42
+
43
+
Add the `conda-forge` channel:
44
+
```shell
45
+
conda config --add channels conda-forge
46
+
conda config --set channel_priority strict
47
+
```
48
+
49
+
Install `causal-testing-framework`:
50
+
```shell
51
+
conda install causal-testing-framework
52
+
```
53
+
54
+
### Alternative: Install from PyPI
55
+
56
+
If you prefer using pip or need the development packages, you can install from PyPI:
31
57
32
58
``pip install causal-testing-framework``
33
59
34
60
or if you want to install with the development packages/tools:
35
61
36
62
``pip install causal-testing-framework[dev]``
37
63
38
-
Alternatively, you can install directly via source:
64
+
### For Developers/Contributors: Install from source
39
65
66
+
If you're planning to contribute to the project or need an editable installation for development, you can install directly from source:
@@ -61,7 +87,6 @@ For more information on how to use the Causal Testing Framework, please refer to
61
87
1. To run the causal testing framework, you need some runtime data from your system, some causal test cases, and a causal DAG that specifies the expected causal relationships between the variables in your runtime data (and any other relevant variables that are _not_ recorded in the data but are known to be relevant).
62
88
63
89
2. If you do not already have causal test cases, you can convert your causal DAG to causal tests by running the following command.
author = {Foster, Michael and Clark, Andrew G. and Somers, Richard and Wild, Christopher and Allian, Farhad and Hierons, Robert M. and Wagg, David and Walkinshaw, Neil},
115
138
title = {CITCOM Software Release},
@@ -118,7 +141,7 @@ and the software citation should contain the specific Figshare [DOI](https://ord
Copy file name to clipboardExpand all lines: docs/source/installation.rst
+33-7Lines changed: 33 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,16 +5,42 @@ Installation
5
5
-----------------
6
6
* We currently support Python versions 3.10, 3.11, 3.12, and 3.13.
7
7
8
-
* The Causal Testing Framework can be installed through either the `Python Package Index (PyPI)`_ (recommended), or directly from source (recommended for contributors).
8
+
* The Causal Testing Framework can be installed through `conda-forge`_ (recommended), the `Python Package Index (PyPI)`_, or directly from source (recommended for contributors).
9
9
10
-
.. _Python Package Index (PyPI): https://dl.acm.org/doi/10.1145/3607184
.. _Python Package Index (PyPI): https://pypi.org/project/causal-testing-framework/
11
12
12
13
.. note::
13
14
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.
14
15
15
-
Method 1: Installing via pip
16
+
Method 1: Installing via conda-forge (Recommended)
**We recommend using conda or mamba for installation**, as they provide better dependency management and environment isolation, particularly for scientific computing workflows.
20
+
21
+
First, create a new conda environment with a supported Python version, e.g::
22
+
23
+
conda create -n causal-testing-env python=3.13
24
+
conda activate causal-testing-env
25
+
26
+
.. note::
27
+
If you have `Miniforge <https://conda-forge.org/download/>`_ installed, you can replace :code:`conda` with :code:`mamba` in any of the commands below for faster package resolution.
28
+
29
+
Add the :code:`conda-forge` channel::
30
+
31
+
conda config --add channels conda-forge
32
+
conda config --set channel_priority strict
33
+
34
+
Install :code:`causal-testing-framework`::
35
+
36
+
conda install causal-testing-framework
37
+
38
+
39
+
Method 2: Installing via pip
16
40
..............................
17
41
42
+
If you prefer using pip or need the development packages, you can install from PyPI.
43
+
18
44
To install the Causal Testing Framework using :code:`pip` for the latest stable version::
19
45
20
46
pip install causal-testing-framework
@@ -26,10 +52,10 @@ If you also want to install the framework with (optional) development packages/t
26
52
pip install causal-testing-framework[dev]
27
53
28
54
29
-
Method 2: Installing via Source
30
-
...............................
55
+
Method 3: Installing via Source (For Developers/Contributors)
* Read about :doc:`modules/causal_specification` to understand causal specifications and :doc:`modules/causal_testing` for the end-to-end causal testing process.
70
96
* Try the command-line interface for quick and simple testing::
0 commit comments