Skip to content

Commit

Permalink
Showing 3 changed files with 23 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -31,7 +31,7 @@ Here are some explanations for the causal inference terminology used above.

## Installation

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).
See the readthedocs site for installation instructions](https://causal-testing-framework.readthedocs.io/en/latest/installation.html).

## Usage

21 changes: 21 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -20,10 +20,31 @@ Alternatively, on Linux systems, this can be done with `sudo apt install graphvi

Install from source
-------------------

In future it will be possible to install from PyPI, but for now...

.. code-block:: console
git clone https://github.com/CITCOM-project/CausalTestingFramework
cd CausalTestingFramework
then, to install a specific release:

.. code-block:: console
git fetch --all --tags --prune
git checkout tags/<tag> -b <branch>
pip install -e .
e.g. version `1.0.0`

.. code-block:: console
git fetch --all --tags --prune
git checkout tags/1.0.0 -b version
pip install -e .
or to install the latest development version:

.. code-block:: console
pip install -e .
Use
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@

setup(
name="causal_testing_framework",
version="0.0.1",
version="1.0.0",
description="A framework for causal testing using causal directed acyclic graphs.",
long_description=readme,
long_description_content_type="text/markdown",

0 comments on commit fcb25c2

Please sign in to comment.