|
| 1 | +<!-- |
| 2 | +# Copyright IBM Corporation 2022 |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | +--> |
| 16 | + |
| 17 | +# AAAI 2023 OCL Lab Instructions |
| 18 | + |
| 19 | +Here are the installation instructions for participants of the OCL Lab. |
| 20 | + |
| 21 | +## `doframework` Installation |
| 22 | + |
| 23 | +We recommend installing `doframework` on a designated Python 3.8.0 environment. `doframework` has many dependancies that may override package versions in your current Python environment. |
| 24 | + |
| 25 | +For example, if you're using `pyenv` in combination with `virtualenv` as your Python environment manager, you can type the following in your terminal |
| 26 | +``` |
| 27 | +$ pyenv virtualenv 3.8.0 dof |
| 28 | +$ pyenv local dof |
| 29 | +``` |
| 30 | +[Here](https://realpython.com/intro-to-pyenv/#virtual-environments-and-pyenv "pyenv and virtualenv") is a good source on `pyenv` and `virtualenv` by Logan Jones. |
| 31 | + |
| 32 | +Now that you've set up a dedicated Python environment, simply install |
| 33 | +``` |
| 34 | +$ pip install doframework |
| 35 | +``` |
| 36 | +Run a simple sanity check with |
| 37 | +``` |
| 38 | +$ python |
| 39 | +>>> import doframework |
| 40 | +>>> exit() |
| 41 | +``` |
| 42 | +The import command may take a while. Once it's finished (successfully, hopefully) you can exit. |
| 43 | + |
| 44 | +## `doframework` Clonning |
| 45 | + |
| 46 | +We will be running `doframework` Jupyter Notebooks as well as using other `doframework` material. Therefore, we'll clone a local copy of `doframework`. From your terminal, run |
| 47 | + |
| 48 | +``` |
| 49 | +$ git clone https://github.com/IBM/doframework.git |
| 50 | +``` |
| 51 | +To launch the OCL lab Jupyter Notebooks, we'll need to add `jupyter` to our new Python environment |
| 52 | +``` |
| 53 | +$ pip install jupyter |
| 54 | +``` |
| 55 | +Note that `jupyter` does not come with `doframework`. We want to keep `doframework` light for cloud distribution. Once we're done installing `jupyter`, let's launch the OCL Lab notebooks |
| 56 | +``` |
| 57 | +$ cd doframework/notebooks |
| 58 | +$ jupyter notebook |
| 59 | +``` |
| 60 | +Now we can begin ... |
0 commit comments