Skip to main content

: Helpful tools for QIS and Pricing Structuring teams

Project description

structools

Helpful tools for QIS and Pricing Structuring teams

Installation

$ pip install structools

Usage

Every new functionality developed in this package has been interfaced so you have very little to do!

Start by creating a file launch.py with the following lines

from structools.launch import start

if __name__ == "__main__":

    start()

Then open the terminal in the folder where the file launch.py is located and simply run the following command

$ streamlit run launch.py

Welcome to Structools!

Advanced/Further Development

For those willing to dive deeper into the code, please find below a brief way to generate your backtest:

import numpy as np
from structools.tools.date_tools import DateModel
from structools.products.basic_products import Basket
from structools.products.autocalls import Phoenix, Athena
from structools.backtest.backtester import Backtester

# Underlying creation Worst-Of 2
nominal = 1_000_000
L_COMPO = ["AAPL", "^FCHI", "^SPX", "MSFT"]
N = len(L_COMPO)
arr_weights = np.ones(N) * 1/N
basket_wof = Basket.from_params(
    size=nominal,
    N=2,
    name="WOF2",
    worst=True,
    best=False,
    weights=arr_weights
)

# Create default phoenix with custom underlying
my_phoenix = Phoenix.from_params(underlying=basket_wof)
my_phoenix.set_parameter("coupon", 0.1)                 # Changing the coupon value to 10

# Configure the backtest - 10 years history for the my_phoenix product
history_length = 10
backtester = Backtester.init_backtester(
    product=my_phoenix,
    backtest_length=history_length,
    investment_horizon=my_phoenix.maturity
)

# Running the backtest
dict_res = backtester.backtester_autocall()

All the functionalities of the root package of this package are still available via the following command:

import pybacktestchain

The relevant information about this pacakage is available here: https://pypi.org/project/pybacktestchain/

Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

License

structools was created by Romain Pifaut. It is licensed under the terms of the MIT license.

Credits

structools was created with cookiecutter and the py-pkgs-cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

structools-0.17.12.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

structools-0.17.12-py3-none-any.whl (27.2 kB view details)

Uploaded Python 3

File details

Details for the file structools-0.17.12.tar.gz.

File metadata

  • Download URL: structools-0.17.12.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for structools-0.17.12.tar.gz
Algorithm Hash digest
SHA256 57d5866be7ad31a8da9338beb79acbbe689469eba7eb73ea09b080c7f9fed604
MD5 70886d15d441db6a77019fec48182019
BLAKE2b-256 8972db5e618600ba5cf2572a694298d6514553b5db2119b9895886ffb0b37e2a

See more details on using hashes here.

File details

Details for the file structools-0.17.12-py3-none-any.whl.

File metadata

  • Download URL: structools-0.17.12-py3-none-any.whl
  • Upload date:
  • Size: 27.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for structools-0.17.12-py3-none-any.whl
Algorithm Hash digest
SHA256 c4018d9634cf7e2a39f51978d2b4776cdacd62d78d8e87e9ba3e0268377ea12d
MD5 d6bed7b84c6b5c1a9281b5a6cdf71131
BLAKE2b-256 f09b0e2d275cd063fea056d71ca80d3c555e670225402671c5e4d67917b647e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page