Updated dependencies for Python packaging and instructions.

Author: chcost

README.md

@@ -59,30 +59,30 @@ This project is under active development. See the [Documentation](https://codefl
 
 ### Run in your laptop
 
-#### Installing locally
+#### Instaling locally
 
 CodeFlare can be installed from PyPI.
 
 Prerequisites:
 * [Python 3.8+](https://www.python.org/downloads/)
 * [JupyterLab](https://jupyter.org) *(to run examples)*
 
-We recommend installing Python 3.8.7 using
-[pyenv](https://github.com/pyenv/pyenv).
+We recommend installing Python 3.8.6 using
+[pyenv](https://github.com/pyenv/pyenv). You can find [here](https://codeflare.readthedocs.io/en/latest/getting_started/setting_python_env.html) recommended steps to set up the Python environment.
 
 
-  Install from PyPI:
-  ```bash
-  pip3 install --upgrade codeflare
-  ```
 
+Install from PyPI:
+```bash
+pip3 install --upgrade pip          # CodeFlare requires pip >21.0
+pip3 install --upgrade codeflare
+```
 
 Alternatively, you can also build locally with:
 ```shell
 git clone https://github.com/project-codeflare/codeflare.git
 pip3 install --upgrade pip
 pip3 install .
-pip3 install -r requirements.txt 
 ```
 
 #### Using Docker
@@ -114,28 +114,42 @@ Click on the link below to try CodeFlare, on a sandbox environment, without havi
 
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/project-codeflare/codeflare.git/develop)
 
+
 ## Pipeline execution and scaling
 
 <p align="center">
 <img src="./images/pipelines.svg" width="296" height="180">
 </p>
 
+## CodeFlare Pipelines
+
 CodeFlare Pipelines reimagined pipelines to provide a more intuitive API for the data scientist to create AI/ML pipelines, data workflows, pre-processing, post-processing tasks, and many more which can scale from a laptop to a cluster seamlessly.
 
-The API documentation can be found [here](https://codeflare.readthedocs.io/en/latest/codeflare.pipelines.html), and reference use case documentation [here](https://codeflare.readthedocs.io/en/latest).
+See the API documentation [here](https://codeflare.readthedocs.io/en/latest/codeflare.pipelines.html), and reference use case documentation in the Examples section.
 
-Examples are provided as executable notebooks: [notebooks](./notebooks). 
+Examples are provided as executable [notebooks](https://github.com/project-codeflare/codeflare/tree/main/notebooks). 
 
-Examples can be run with locally with:
+To run examples, if you haven't done so yet, clone the CodeFlare project with:
+
+```bash
+git clone https://github.com/project-codeflare/codeflare.git
+```
+
+Example notebooks require JupyterLab, which can be installed with:
+```bash
+pip3 install --upgrade jupyterlab
+```
+
+Use the command below to run locally:
 ```shell
-jupyter-lab notebooks/<example_notebook>
+jupyter-lab codeflare/notebooks/<example_notebook>
 ```
 
-If running with the container image, examples are found in `codeflare/notebooks`, which can be executed directly from Jupyter environment. 
+The step above should automatically open a browser window and connect to a running Jupyter server.
 
-As a first example, we recommend the [sample pipeline](https://github.com/project-codeflare/codeflare/blob/main/notebooks/sample_pipeline.ipynb).
+If you are using any one of the recommended cloud based deployments, examples are found in the `codeflare/notebooks` directory in the container image. The examples can be executed directly from the Jupyter environment. 
 
-The pipeline will use `ray.init()` to start a local Ray cluster. See the deployment options below to run a Ray cluster on in the cloud, or the details [here](https://docs.ray.io/en/master/configure.html) if you are running a Ray cluster locally.
+As a first example, we recommend the [sample pipeline](https://github.com/project-codeflare/codeflare/blob/main/notebooks/sample_pipeline.ipynb).
 
 ## Deploy and integrate anywhere
 

codeflare/_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = '0.1.0.dev0'
+__version__ = '0.1.1.dev0'

deploy/redhat_openshift/README.md

@@ -28,6 +28,7 @@ We recommend installing Python 3.8.7 using
 
 Install from PyPI:
 ```bash
+pip3 install --upgrade pip          # CodeFlare requires pip >21.0
 pip3 install --upgrade codeflare
 ```
 
@@ -36,7 +37,6 @@ Alternatively, you can also build locally with:
 git clone https://github.com/project-codeflare/codeflare.git
 pip3 install --upgrade pip
 pip3 install .
-pip3 install -r requirements.txt 
 ```
 
 2. Create Cluster (https://docs.ray.io/en/master/cluster/cloud.html#kubernetes)

docs/source/getting_started/installation.md

@@ -26,24 +26,24 @@ CodeFlare can be installed from PyPI.
 
 Prerequisites:
 * [Python 3.8+](https://www.python.org/downloads/)
-* [Jupyter Lab](https://www.python.org/downloads/) *(to run examples)*
+* [JupyterLab](https://jupyter.org) *(to run examples)*
 
-We recommend installing Python 3.8.7 using
-[pyenv](https://github.com/pyenv/pyenv).
+We recommend installing Python 3.8.6 using
+[pyenv](https://github.com/pyenv/pyenv). You can find [here](./setting_python_env.md) recommended steps to set up the Python environment.
 
 
-  Install from PyPI:
-  ```bash
-  pip3 install --upgrade codeflare
-  ```
 
+Install from PyPI:
+```bash
+pip3 install --upgrade pip          # CodeFlare requires pip >21.0
+pip3 install --upgrade codeflare
+```
 
 Alternatively, you can also build locally with:
 ```shell
 git clone https://github.com/project-codeflare/codeflare.git
 pip3 install --upgrade pip
 pip3 install .
-pip3 install -r requirements.txt 
 ```
 
 #### Using Docker

docs/source/getting_started/setting_python_env.md

@@ -0,0 +1,83 @@
+<!--
+{% comment %}
+Copyright 2021 IBM
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% endcomment %}
+-->
+
+[pyenv](https://github.com/pyenv/pyenv) is a tool that can be used to easily enable and switch between multiple versions of Python.
+
+It can be installing with:
+
+[MacOS]
+
+1. Install via Homebrew
+
+pyenv can be installed with [Homebrew](https://brew.sh) with the following command:
+
+```bash
+# Requires admin privileges
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+*Note:* If you don't have Xcode Command Line installed yet, this step will request confirmation and install it.
+
+2. Install pyenv:
+
+```bash
+brew install pyenv 
+```
+
+3. Install Python (CodeFlare has been tested with 3.8.6):
+
+```bash
+pyenv install 3.8.6
+```
+
+4. Set global default:
+```bash
+pyenv global 3.8.6
+```
+and verify it worked:
+
+```bash
+pyenv version
+3.8.6 (set by /Users/<user>/.pyenv/version)
+```
+
+5. Set up shell path:
+
+Add the following to your `~/.bash_profile` (*Note*: the you may have to create the the file)
+
+```bash
+export PYENV_ROOT="$HOME/.pyenv" 
+export PATH="$PYENV_ROOT/bin:$PATH"
+eval "$(pyenv init --path)"
+
+eval "$(pyenv init -)"
+```
+
+You will have to source your profile for changes to take affect:
+
+```bash
+source ~/.bash_profile
+```
+
+6. Confirm Python version
+
+```bash
+python --version
+Python 3.8.6
+```
+

docs/source/pipelines/pipelines_overview.md

@@ -26,11 +26,24 @@ See the API documentation [here](https://codeflare.readthedocs.io/en/latest/code
 
 Examples are provided as executable [notebooks](https://github.com/project-codeflare/codeflare/tree/main/notebooks). 
 
-Notebooks can can be run with locally with:
+To run examples, if you haven't done so yet, clone the CodeFlare project with:
+
+```bash
+git clone https://github.com/project-codeflare/codeflare.git
+```
+
+Example notebooks require JupyterLab, which can be installed with:
+```bash
+pip3 install --upgrade jupyterlab
+```
+
+Use the command below to run locally:
 ```shell
-jupyter-lab notebooks/<example_notebook>
+jupyter-lab codeflare/notebooks/<example_notebook>
 ```
 
-Or, if using any of the recommended cloud based deployments, examples are found in `codeflare/notebooks`, which can be executed directly from Jupyter environment. 
+The step above should automatically open a browser window and connect to a running Jupyter server.
+
+If you are using any one of the recommended cloud based deployments, examples are found in the `codeflare/notebooks` directory in the container image. The examples can be executed directly from the Jupyter environment. 
 
 As a first example, we recommend the [sample pipeline](https://github.com/project-codeflare/codeflare/blob/main/notebooks/sample_pipeline.ipynb).

setup.py

@@ -39,7 +39,14 @@
     version=version_ns['__version__'],
     packages=['codeflare', 'codeflare.pipelines', 'codeflare.pipelines.tests'],
     install_requires=[
-        'ray[default,serve,k8s]>=1.3.0'
+        'ray[default,serve,k8s]>=1.3.0',
+        'setuptools>=52.0.0',
+        'sklearn>=0.0',
+        'scikit-learn>=0.24.1',
+        'pandas>=1.2.4',
+        'numpy>=1.18.5',
+        'pickle5>=0.0.11', 
+        'graphviz>=0.16',
     ],
     url='https://github.com/project-codeflare/codeflare',
     license='Apache v2.0',