From 4fcf55dabdef1afc589f1bcd6db28fcff714c74b Mon Sep 17 00:00:00 2001 From: Harshit Shah <139583216+harshit4311@users.noreply.github.com> Date: Sun, 4 Aug 2024 20:46:41 +0530 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 6d8378da..4a614996 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Please refer to [Goldman Sachs Developer](https://developer.gs.com/docs/gsquant/ * Python 3.6 or greater * Access to PIP package manager +* Client ID and secret for API access (for institutional clients) ## Installation @@ -19,6 +20,29 @@ Please refer to [Goldman Sachs Developer](https://developer.gs.com/docs/gsquant/ pip install gs-quant ``` +## Development Setup +1.) Clone the Repository +``` +git clone https://github.com/your-organization/gs-quant.git +cd gs-quant +``` + +2.) Create a Virtual Environment +``` +python -m venv env +source env/bin/activate # On Windows use `env\Scripts\activate` +``` + +3.) Install Dependencies +``` +pip install -r requirements.txt +``` + +4.) Install GS Quant Locally +``` +pip install -e . +``` + ## Examples You can find examples, guides and tutorials in the respective folders as well as on [Goldman Sachs Developer](https://developer.gs.com/docs/gsquant/).