diff --git a/README.md b/README.md index 73d7cfa..899979a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # CMLDA -Repository for the course Computational Mathematics for Learning and Data Analysis \ No newline at end of file +Repository for the course Computational Mathematics for Learning and Data Analysis. + +# Installation +These steps are for MacOS, with [```brew```](brew.sh) and ```python3``` already installed. + +## Installing Julia + +```sh +brew install julia +``` + +## Installing JupyterLab and IJulia kernel + +### IJulia kernel + +Inside the julia REPL: +```julia +using Pkg +Pkg.add("IJulia") +``` + +A simple notebook experience can be obtained by simply running ```noteboot()```, which will install in a separate [```conda```](https://docs.conda.io/en/latest/) environment the needed python packages. + +### JupyterLab + +A separate environment with [```virtualenv```](https://pypi.org/project/virtualenv/) or [```virtualenvwrapper```](https://pypi.org/project/virtualenvwrapper/) is recommended. + +```sh +pip install jupyterlab +``` + +# Running + +To run simply start the notebook with ```jupyter lab``` , the julia kernel should be automatically detected.