Giter VIP home page Giter VIP logo

options-pricer's Introduction


Overview

Options Pricer is a web application for pricing options using the Black-Scholes and Binomial pricing models.

Options Pricer features:

  • Interactive frontend user interface for computing options prices
  • REST API exposing pricing models as endpoints

Models

The Black-Scholes model works primarily on European options. It provides users with an accurate options price without requiring a large amount of computational resources. The Black-Scholes model is not as flexible as other models, but it provides a solid baseline for pricing options quickly.

On the other hand, the Binomial model is a more accurate model that is slower as it requires a larger amount of computational resources. It provides the same result as the Black-Scholes model when used for European options. Comparitively, the Binomial model is more flexible, as it allows the user to account for early exercise — which are possible when dealing with American options. Here, the Binomial model computes the price for American options.

Self-Hosting

Options Pricer can easily be self hosted. Dockerfiles have been provided as official releases here. If you would like to locally build the application, follow the steps below.

  1. Ensure that Rust, Node.js and Screen are installed on the machine.

  2. Clone the repository with git clone https://github.com/ayushgun/options-pricer.

  3. Run the pricer.sh script with the start argument to start the application: ./pricer.sh start.

Note: To stop the application, run the pricer.sh script with the kill argument: ./pricer.sh kill.

Testing

If you plan on modifying the API, a default test suite has been included in this repository.

To run the test suite:

  1. Ensure that Python and pip is installed on the machine.

  2. Start the API with the script: ./pricer.sh start.

  3. Move to the test suite directory with cd tests. Then, install the test suite dependencies with pip3 install -r requirements.txt.

  4. Run the test suite with python3 api_tests.py.

Contributing

We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting an issue
  • Discussing the current state of the project
  • Submitting a fix
  • Proposing new features

To get started, check Issues for a list of tracked issues.

Acknowledgements

Ayush Gundawar and Sriharsha Kocherla are the authors of this project.

React is the library used to build the frontend UI.

Actix is the web framework used to build the backend API. It is a powerful, pragmatic, and performant HTTP web framework.

options-pricer's People

Contributors

ayushgun avatar svkocherla avatar dependabot[bot] avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.