Installation updates to README and .github/workflows

.github/workflows/test-build-from-source.yml

@@ -0,0 +1,79 @@
+name: Test build from source install
+
+on:
+  push:
+    paths:
+      - 'envs/*.yml'
+      - '.github/workflows/test-build-from-source.yml'
+
+jobs:
+  build:
+    name: ${{ matrix.os }}${{ matrix.tf-label }}-py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.7, 3.8, 3.9]
+        tf-label: ['', '-tf']
+        include:
+          - python-version: 3.7
+            python-version-nd: 37
+          - python-version: 3.8
+            python-version-nd: 38
+          - python-version: 3.9
+            python-version-nd: 39
+          - tf-label: '-tf'
+            tf-label-pip: '[tf]'
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: create environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: causalml${{ matrix.tf-label }}-py${{ matrix.python-version-nd }} 
+          python-version: ${{ matrix.python-version }}
+          channels: defaults
+
+      - name: install cxx-compiler 
+        run: |
+          conda install -c conda-forge cxx-compiler
+
+      - name: echo conda config
+        run: |
+          conda info
+          conda list
+          conda config --show-sources
+          conda config --show  
+
+      - name: Build
+        run: |
+            pip install -U pip
+            pip install -U setuptools
+            python -m pip install .${{ matrix.tf-label-pip}}
+            python -m pip install .[test]
+            python setup.py build_ext --inplace
+
+      - name: Test with pytest
+        run: pytest -vs tests/ --cov causalml/
+
+      - name: echo conda env
+        run: |
+          conda env export
+
+

.github/workflows/test-conda-forge-install.yml

@@ -0,0 +1,44 @@
+name: Test conda-forge install
+
+on: 
+  push:
+    paths:
+      - 'envs/*.yml'
+      - '.github/workflows/test-conda-forge-install.yml'
+
+jobs:
+  build:
+    name: ${{ matrix.os }}-py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.7, 3.8, 3.9]
+        include:
+          - python-version: 3.7
+            python-version-nd: 37
+          - python-version: 3.8
+            python-version-nd: 38
+          - python-version: 3.9
+            python-version-nd: 39
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: create environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: causalml-py${{ matrix.python-version-nd }} 
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install from conda-forge 
+        run: |
+            conda install -c conda-forge causalml

.github/workflows/test-conda-venv-install.yml

@@ -0,0 +1,68 @@
+name: Test conda-venv install
+
+on:
+  push:
+    paths:
+      - 'envs/*.yml'
+      - '.github/workflows/test-conda-venv-install.yml'
+
+jobs:
+  build:
+    name: ${{ matrix.os }}${{ matrix.tf-label }}-py${{ matrix.python-version-nd }}
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.7, 3.8, 3.9]
+        tf-label: ['', '-tf']
+        include:
+          - python-version: 3.7
+            python-version-nd: 37
+          - python-version: 3.8
+            python-version-nd: 38
+          - python-version: 3.9
+            python-version-nd: 39
+          - tf-label: '-tf'
+            tf-label-pip: '[tf]'
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v2
+
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: create environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          channels: defaults
+          auto-activate-base: false
+          activate-environment: causalml${{ matrix.tf-label }}-py${{ matrix.python-version-nd }}
+          environment-file: envs/environment${{ matrix.tf-label }}-py${{ matrix.python-version-nd }}.yml
+
+      - name: echo conda config
+        run: |
+          conda info
+          conda list
+          conda config --show-sources
+          conda config --show  
+
+      - name: Build
+        run: |
+            pip install -U pip
+            pip install -U setuptools
+            python -m pip install .[test]
+            python setup.py build_ext --inplace
+
+      - name: Test with pytest
+        run: pytest -vs tests/ --cov causalml/
+
+      - name: echo conda env
+        run: |
+          conda env export

.github/workflows/test-pypi-install.yml

@@ -0,0 +1,39 @@
+name: Test PyPI install
+
+on: [push]
+
+jobs:
+  build:
+    name: ${{ matrix.os }}-py${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.7, 3.8, 3.9]
+        include:
+          - python-version: 3.7
+            python-version-nd: 37
+          - python-version: 3.8
+            python-version-nd: 38
+          - python-version: 3.9
+            python-version-nd: 39
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+
+      - name: create environment
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: causalml-py${{ matrix.python-version-nd }} 
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install using pip
+        run: |
+          pip install causalml

README.md

@@ -52,56 +52,82 @@ The package currently supports the following methods
 
 # Installation
 
-Installation with `conda` is recommended. `conda` environment files for Python 3.7, 3.8 and 3.9 are available in the repository. To use models under the `inference.tf` module (e.g. `DragonNet`), additional dependency of `tensorflow` is required. For detailed instructions, see below.
+Installation with `conda` is recommended.
+
+`conda` environment files for Python 3.7, 3.8 and 3.9 are available in the repository. To use models under the `inference.tf` module (e.g. `DragonNet`), additional dependency of `tensorflow` is required. For detailed instructions, see below.
 
 ## Install using `conda`:
+
+Install `conda` with:
+
+```
+wget https://repo.anaconda.com/miniconda/Miniconda3-py38_23.5.0-3-Linux-x86_64.sh
+bash Miniconda3-py38_23.5.0-3-Linux-x86_64.sh -b
+source miniconda3/bin/activate 
+conda init
+source ~/.bashrc 
+```
+
 ### Install from `conda-forge`
 Directly install from the conda-forge channel using conda.
 
 ```sh
-$ conda install -c conda-forge causalml
+conda install -c conda-forge causalml
 ```
 
 ### Install with the `conda` virtual environment
 This will create a new `conda` virtual environment named `causalml-[tf-]py3x`, where `x` is in `[6, 7, 8, 9]`. e.g. `causalml-py37` or `causalml-tf-py38`. If you want to change the name of the environment, update the relevant YAML file in `envs/`
 
 ```bash
-$ git clone https://github.com/uber/causalml.git
-$ cd causalml/envs/
-$ conda env create -f environment-py38.yml	# for the virtual environment with Python 3.8 and CausalML
-$ conda activate causalml-py38
+git clone https://github.com/uber/causalml.git
+cd causalml/envs/
+conda env create -f environment-py38.yml	# for the virtual environment with Python 3.8 and CausalML
+conda activate causalml-py38
 (causalml-py38)
 ```
 
 ### Install `causalml` with `tensorflow`
 ```bash
-$ git clone https://github.com/uber/causalml.git
-$ cd causalml/envs/
-$ conda env create -f environment-tf-py38.yml	# for the virtual environment with Python 3.8 and CausalML
-$ conda activate causalml-tf-py38
+git clone https://github.com/uber/causalml.git
+cd causalml/envs/
+conda env create -f environment-tf-py38.yml	# for the virtual environment with Python 3.8 and CausalML
+conda activate causalml-tf-py38
 (causalml-tf-py38) pip install -U numpy			# this step is necessary to fix [#338](https://github.com/uber/causalml/issues/338)
 ```
 
 ## Install from `PyPI`:
 
 ```bash
-$ pip install causalml
+pip install causalml
 ```
 
 ### Install `causalml` with `tensorflow`
 ```bash
-$ pip install causalml[tf]
-$ pip install -U numpy							# this step is necessary to fix [#338](https://github.com/uber/causalml/issues/338)
+pip install causalml[tf]
+pip install -U numpy							# this step is necessary to fix [#338](https://github.com/uber/causalml/issues/338)
 ```
 
 ## Install from source:
 
+### gcc, g++
+`gcc` and `g++` must be installed on the system to compile C/C++ libraries.
+
+For example, on ubuntu this can be done with:
+
+```
+sudo apt-get install -y gcc g++
+```
+
+Then:
+
 ```bash
-$ git clone https://github.com/uber/causalml.git
-$ cd causalml
-$ pip install .
+git clone https://github.com/uber/causalml.git
+cd causalml
+pip install .
 ```
+
 with `tensorflow`:
+
 ```bash
 pip install .[tf]
 ```