Skip to content

Commit

Permalink
update README and template_docker-compose
Browse files Browse the repository at this point in the history
  • Loading branch information
gnzsnz committed Sep 27, 2024
1 parent a2c4a7f commit 0be3136
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ a commented line with `START_SCRIPTS=/home/gordon/Notebooks/etc/start_scripts`
as an example and recommended location.

Files should have a `.sh` suffix and should run under `bash`. On you will find
scripts to load ssh keys and install python packages in directory
example scripts to load ssh keys and install python packages in directory
[start_scripts](https://github.com/quantbelt/jupyter-quant/tree/master/start_scripts).

### Install jupyter-quant package
Expand All @@ -216,3 +216,11 @@ Jupyter-quant is available as a package in pypi.
```bash
pip install -U jupyter-quant
```

Additional options supported are

```bash
pip install -U jupyter-quant[bayes] # to install pymc & arviz/graphviz
pip install -U jupyter-quant[sk-util] # to install skfolio & sktime
```
9 changes: 9 additions & 0 deletions template_docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ services:
APT_PROXY: ${APT_PROXY}
BYODF: ${BYODF:-}
SSH_KEYDIR: ${SSH_KEYDIR:-}
# START_SCRIPTS: ${START_SCRIPTS:-}
# SSH_PASSPHRASE: ${SSH_PASSPHRASE:-}
# SSH_PASSPHRASE_FILE: ${SSH_PASSPHRASE_FILE:-}
TZ: ${QUANT_TZ:-}
restart: unless-stopped
ports:
Expand All @@ -25,7 +28,13 @@ services:
- quant_conf:/home/gordon/.config
- quant_data:/home/gordon/.local
- ${PWD}/Notebooks:/home/gordon/Notebooks
# secrets:
# - ssh_passphrase

volumes:
quant_conf:
quant_data:

# secrets:
# ssh_passphrase:
# file: pass/ssh_password.txt

0 comments on commit 0be3136

Please sign in to comment.