Skip to content

Add development setup and contributing guidelines in README.md #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add development setup and contributing guidelines in README.md #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,37 @@ 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

```
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/).
Expand Down