Skip to content
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.

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

Add development setup instructions #299

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
64 changes: 62 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,80 @@ 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 .
```

## Building the Project
If the project requires a build step, describe it here. For example:

```
# Example build command
python setup.py build
```

## Running Tests
To run tests, use the following command:
```
pytest
```
Make sure to run tests before submitting any changes.


## Contributing
Contributions are welcome! Please follow these guidelines:
1.) Fork the Repository: Use the GitHub interface to fork the repository to your own account.
2.) Create a Branch: Create a feature branch for your changes
```
git checkout -b feature/your-feature-name
```

3.) Commit Your Changes: Write descriptive commit messages.
```
git commit -m "Add feature X"
```

4.) Push to Your Fork: Push your changes to your forked repository.
```
git push origin feature/your-feature-name
```

5.) Submit a Pull Request: Go to the original repository on GitHub and submit a pull request.

Please see [CONTRIBUTING](CONTRIBUTING.md) for more details.

## 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/).

## Contributions

Contributions are encouraged! Please see [CONTRIBUTING](CONTRIBUTING.md) for more details.

## Help

Expand Down