Bond Pricing Tool for MATLAB Production Server Python Client

This example shows how to create an application that calculates a bond price from a simple formula. You run this example by entering the following known values into a simple graphical interface:

• Coupon payment — C

• Number of payments — N

• Interest rate — i

• Value of bond or option at maturity — M

The application calculates price (P) based on the following equation: P = C * ( (1 - (1 + i)^-N) / i ) + M * (1 + i)^-N.

The bond pricing tool demonstrates the following features of MATLAB® Production Server™:

• Deploy a simple MATLAB function with a fixed number of inputs and a single output.

• Deploy a MATLAB function with a simple GUI front-end for data input.

Write MATLAB Code

Save the following code under the filename pricecalc.m.

function price = pricecalc(value_at_maturity,coupon_payment, ...
                           interest_rate,num_payments)
%% Following formula has been obtained from wikipedia: http://en.wikipedia.org/wiki/Bond_valuation

% Copyright 1984-2019 The MathWorks, Inc.
% All Rights Reserved.

    C = coupon_payment;
    N = num_payments;
    i = interest_rate;
    M = value_at_maturity;
    
    price = C * ( (1 - (1 + i)^-N) / i ) + M * (1 + i)^-N;

end

Create a Deployable Archive with the Production Server Archive Compiler App

To create the deployable archive for this example:

1. In MATLAB, under the Apps tab, select the Production Server Archive Compiler app.

2. In the Exported Functions field, add pricecalc.m.

3. Under Application Information, ensure that the archive name is pricecalc.

4. Click Package.

The generated deployable archive, pricecalc.ctf, is located in the output directory of the project’s folder.

Share the Deployable Archive on a Server

1. Download the MATLAB Runtime, if needed, at https://www.mathworks.com/products/compiler/mcr. See Supported MATLAB Runtime Versions for MATLAB Production Server for more information.

2. Create a server using mps-new. See Create Server Instance Using Command Line for more information.

3. Specify the location of the MATLAB Runtime to the server by editing the server configuration file, main_config, and specifying a path for --mcr-root. See Server Configuration Properties for details.

4. Start Server Instance Using Command Line and Verify Server Status.

5. Copy the pricecalc.ctf file to the auto_deploy folder on the server for hosting.

Write Python Client Code

Before you write the client application, you must have the MATLAB^® Production Server™ Python^® client libraries installed on your system. For details, see Install the MATLAB Production Server Python Client.

Copy the following Python code:

 interestapp.py

from tkinter import *
import matlab
from matlab.production_server import client
window = Tk()
client_object = client.MWHttpClient('http://localhost:9910')

window.title("Bond Pricing Tool")
window.geometry('350x350')

#Face Value Scale

fv_lbl = Label(window, text="Face Value")
fv_lbl.grid(column=0, row=0)

face_val = IntVar()

fv_scl = Scale(window, variable = face_val, from_ = 0, to = 1000)
fv_scl.grid(column=1, row=0)
fv_scl['orient'] = HORIZONTAL

#Coupon Yield

cy_lbl = Label(window, text="Coupon Yield")
cy_lbl.grid(column=0, row=1)

coupon_yield = IntVar()

cy_scl = Scale(window, variable = coupon_yield, from_ = 0, to = 1000)
cy_scl.grid(column=1, row=1)
cy_scl['orient'] = HORIZONTAL

#Interest Rate

ir_lbl = Label(window, text="Interest Rate(%)")
ir_lbl.grid(column=0, row=2)

interest_rate = IntVar()

ir_scl = Scale(window, variable = interest_rate, from_ = 0, to = 100)
ir_scl.grid(column=1, row=2)
ir_scl['orient'] = HORIZONTAL

#Number of Payments

np_lbl = Label(window, text="Number of Payments")
np_lbl.grid(column=0, row=3)

num_of_payments = IntVar()

np_scl = Scale(window, variable = num_of_payments, from_ = 0, to = 100)
np_scl.grid(column=1, row=3)
np_scl['orient'] = HORIZONTAL


#Bond Price

def calculate_bond_price(val):
    bond_price = client_object.pricecalc.pricecalc(float(face_val.get()), float(coupon_yield.get()), interest_rate.get()/100, float(num_of_payments.get()))
    bp_lbl = Label(window, text="Bond Price: " + str(round(bond_price,2)))
    bp_lbl.grid(column=1, row=4)

fv_scl['command'] = calculate_bond_price
cy_scl['command'] = calculate_bond_price
np_scl['command'] = calculate_bond_price
ir_scl['command'] = calculate_bond_price

window.mainloop()

The Python Client for MATLAB Production Server includes the matlab Python Module. Use the matlab.production_server.client.MWHttpClient to establish a connection to MATLAB Production Server. For more information on establishing a client connection, see Create Client Connection.

In the calculate_bond_price Python function, client_object calls the pricecalc MATLAB function, which takes four float scalars and returns a double scalar. The bond_price variable stores the result of the function call. calculate_bond_price is called whenever a user moves the value of the scale. For information on conversion between other Python and MATLAB data types, see Pass Data Between MATLAB Production Server and Python. For information on using MATLAB arrays in Python, see Use MATLAB Arrays in Python.

Run the Client Code

Before you attempt to build and run your client code, ensure that you have done the following:

• Copy your deployable archive to your server auto_deploy folder.

• Modified your server main_config file to point to where your MATLAB Runtime is installed.

• Start the server instance and verify that it is running. See Start Server Instance Using Command Line and Verify Server Status.

Run the Python code. The tool opens.