Skip to content

Commit fcb25c2

Browse files
authored
Merge branch 'main' into enum_variables
2 parents 07e96c6 + 024948f commit fcb25c2

File tree

3 files changed

+23
-2
lines changed

3 files changed

+23
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Here are some explanations for the causal inference terminology used above.
3131

3232
## Installation
3333

34-
To use the causal testing framework, clone the repository, `cd` into the root directory, and run `pip install -e .`. More detailled installation instructions can be found in the [online documentation](https://causal-testing-framework.readthedocs.io/en/latest/installation.html).
34+
See the readthedocs site for installation instructions](https://causal-testing-framework.readthedocs.io/en/latest/installation.html).
3535

3636
## Usage
3737

docs/source/installation.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,31 @@ Alternatively, on Linux systems, this can be done with `sudo apt install graphvi
2020

2121
Install from source
2222
-------------------
23+
24+
In future it will be possible to install from PyPI, but for now...
25+
2326
.. code-block:: console
2427
2528
git clone https://github.com/CITCOM-project/CausalTestingFramework
2629
cd CausalTestingFramework
30+
31+
then, to install a specific release:
32+
33+
.. code-block:: console
34+
git fetch --all --tags --prune
35+
git checkout tags/<tag> -b <branch>
36+
pip install -e .
37+
38+
e.g. version `1.0.0`
39+
40+
.. code-block:: console
41+
git fetch --all --tags --prune
42+
git checkout tags/1.0.0 -b version
43+
pip install -e .
44+
45+
or to install the latest development version:
46+
47+
.. code-block:: console
2748
pip install -e .
2849
2950
Use

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
setup(
2323
name="causal_testing_framework",
24-
version="0.0.1",
24+
version="1.0.0",
2525
description="A framework for causal testing using causal directed acyclic graphs.",
2626
long_description=readme,
2727
long_description_content_type="text/markdown",

0 commit comments

Comments
 (0)