/nsc

A repository containing source code for Nassau Street Capital

Primary LanguagePythonMIT LicenseMIT

Nassau Street Capital

An open source repository containing utility source code for quantitative finance and other software engineering builds for Nassau Street Capital, a student-run investment club at Princeton University.

📚 Table of Contents

Getting started

To get started, you will need to create the nsc virtual environment.

  1. Install Poetry (highly recommended)
$ pip install poetry
  1. Create the nsc virtual environment
$ mkdir .venv
$ poetry config virtualenvs.in-project true
$ poetry shell

If poetry did not automatically activate the virtual environment for you, you can do so manually with

$ source .venv/bin/activate

Note that will have to input the analogous command if you are not using the Unix terminal.

  1. Install dependencies
$ poetry install --no-root

Alternative: Non-poetry installation involves the following steps in the root directory:

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt

Without poetry, you are responsible for managing dependency versions.

Contributing

If you're interested in contributing, please fork the repository and submit a pull request. For major changes, open an issue first.

Developers (alphabetical by last name)

This repository is currently being maintained by

  • Windsor Nguyen '25

License

Nassau Street Capital is licensed under the terms of the MIT License.