Skip to content

Commit f5ed65d

Browse files
committed
better usage description
1 parent 725bd1e commit f5ed65d

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ First of all, this is not a book!
3636
Every notebook is (almost) independent from the others. Therefore you can select only the notebook you are interested in!
3737

3838
```diff
39-
- Every notebook, contains python code ready to use!
39+
- Every notebook contains python code ready to use!
4040
```
4141

4242
It is not easy to find on internet examples of financial models implemented in python which are ready to use and well documented.
@@ -118,8 +118,13 @@ You have several options:
118118

119119
1) **Docker:** Install [docker](https://www.docker.com/) following the instructions in [install link](https://docs.docker.com/install/)
120120

121-
At this point, you just need to run the script ```docker_start_notebook.py``` and you are done.
122-
This script will download the data-science docker image [scipy-notebook](https://hub.docker.com/r/jupyter/scipy-notebook), that will be used every time you run the script (the script will take about 10-15 minutes to download the image, ONLY the first time). You can also download a different image by modifying the script. For a list of images see [here](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html).
121+
At this point, you just need to run the script `docker_start_notebook.py`, i.e enter in the shell the following code:
122+
123+
```bash
124+
python docker_start_notebook.py
125+
```
126+
127+
The script will download the data-science docker image [scipy-notebook](https://hub.docker.com/r/jupyter/scipy-notebook), that will be used every time you run the script (the script will take about 10-15 minutes to download the image, ONLY the first time). You can also download a different image by modifying the script. For a list of images see [here](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html).
123128

124129
2) **Virtual environment:**
125130
Here I explain how to create a virtual environment with [Anaconda](https://www.anaconda.com/distribution/). A possible alternative could be to use the python module [venv](https://docs.python.org/3.7/tutorial/venv.html).
@@ -130,8 +135,13 @@ source activate FMNM
130135
pip install --requirement requirements.txt
131136
```
132137

133-
3) If you prefer to use the python version already installed in your system, you just need to enter `jupyter-notebook` in the shell.
134-
However, if you are using an old version, there could be compatibility problems.
138+
3) If you prefer to use the python version already installed in your system, you just need to check that all the packages listed in `requirements.txt` are installed, and then enter in the shell the code:
139+
140+
```bash
141+
jupyter-notebook
142+
```
143+
144+
However, if you are using old versions, there could be compatibility problems.
135145

136146

137147
#### If you wish to use a different python version or a different docker image, you will probably need to recompile the Cython code!
@@ -141,7 +151,7 @@ If you are using the data science image, you can open the shell in the notebooks
141151
python docker_start_notebook.py
142152
```
143153

144-
after that, copy-paste the following code into the shell:
154+
after that, paste the following code into the shell:
145155

146156
```bash
147157
docker exec -it Numeric_Finance bash

0 commit comments

Comments
 (0)