Get Started

Note

Rateslib-excel is not downloadable. The files are provided as part of the distribution to users with an extended commercial licence.

Requirements

To use rateslib-excel you will need:

• Python (>=3.10) and an environment with rateslib installed.

• A supported version of Excel and either the pyxll add-in, or the xloil add-in, installed and working.

• A commercial licence extension to use rateslib and the provided rateslib-excel module files.

Setup

Pyxll

Note

This guide and setup installations were based on Pyxll 5.11.2

If you are using pyxll and it is working normally in Excel then perform the following tasks:

1. Move the provided rateslib-excel files to a directory location on your local drive. E.g. C:\Users\your-user-id\rateslib-excel\

2. Open the pyxll.cfg configuration file and add that named directory to the following relevant config sections:

   Path

   [PYTHON]
   ; ...
   pythonpath =
          ./examples
          C:\Users\your-user-id\rateslib-excel
   

   Imported Modules

   [PYXLL]
   ; ...
   modules =
          misc
          ; ...
          rateslib_pyxll_module
   

   Cached Object Display

   [PYXLL]
   ; ...
   get_cached_object_id = rateslib_pyxll_module.get_cached_object_id
   

   In this last step make sure to remove the semi-colon at the start of the line to uncomment it!

3. Restart Excel and the rateslib-excel library functions will be available!

xlOil

Note

This guide and setup installations were based on XlOil 0.21.0

If you are using xloil and it is working normally in Excel then perform the following tasks:

1. Move the provided rateslib-excel files to a directory location on your local drive. E.g. C:\Users\your-user-id\rateslib-excel\

2. Open the xloil ribbon menu and add this directory to the ‘search paths’ input box.

3. Add ‘rateslib_xloil_module’ to the ‘load modules’ input box.

4. Restart Excel and the rateslib-excel library functions will be available!