change readme

This commit is contained in:
Michael Duong 2024-08-05 23:09:25 +01:00
parent c224f52a0f
commit ec7149e56e

View file

@ -17,14 +17,15 @@ Within `src` folder, the structure is as follows:
# How to develop using this pipeline:
Run `make init`, which will:
- Download pyenv (Python version management)
- Download Python 3.X.X as defined in the `make` file - current 3.10.12
- Create a virtual environment with this version of python
First, download miniconda to use conda to manage Python Environments
Rund `conda init`, to initialise your terminal
Change to this directory and run `make init`, which will:
- Create a conda virtual environment with this version of python - current 3.10.12
- Install packages in the training and version control directories in the pipeline folder (dev version if applicable)
- Install pre-commit to enable pre-commit hooks
To use the environment, run `source .dev_env_pipeline/bin/activate`.
To use the environment, run `conda activate dev_env_pipeline`
To enable the virtual envrionemnt created in vscode:
- Open settings