docs: QuantLibAAD naming, migration notes and 1.41.0 changelog

Author: auto-differentiation-dev

CHANGELOG.md

@@ -1,17 +1,21 @@
 # ChangeLog
 
 This log is to be read in conjunction with [ChangeLog.txt](./ChangeLog.txt). 
-It lists the QuantLib-Risks specific changes on top of what is already listed in 
+It lists the QuantLibAAD (formerly QuantLib-Risks) specific changes on top of what is already listed in 
 the underlying QuantLib-SWIG changelog.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [1.41.0] - Unreleased
 
+- Renamed QuantLib-Risks -> QuantLibAAD: `pip install QuantLibAAD`, `import QuantLibAAD`
+- `QuantLib-Risks` 1.41.0 is a deprecated shim (`shim/`) that requires `QuantLibAAD==1.41.*` and
+  re-exports it as `QuantLib_Risks` with a `DeprecationWarning`
+- Anyone pinned to `QuantLib-Risks==1.33.3` must also pin `xad<2`
 - Matches QuantLib and QuantLib Python bindings version 1.41
 - Builds against QuantLibAAD 1.41 (formerly QuantLib-Risks-Cpp) and the shared libxad of the installed xad 2.2 package (`xad>=2.2,<2.3`), which is not bundled
-- Tapes are shared with xad through libxad, thread-local per Python thread; QuantLib no longer patches `xad.adj_1st.Tape`
+- Tapes are shared with xad through libxad, thread-local per Python thread
 - Builds the unmodified QuantLib 1.41 release, no QuantLib patches
 - One-step build with scikit-build-core; wheels for Python 3.10-3.14 on Linux, macOS and Windows
 - `tools/sync-swig.sh` syncs `SWIG/` with a QuantLib-SWIG release, re-applying the XAD changes in `SWIG/patches/`
@@ -32,7 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Initial release, matching QuantLib Python bindings version 1.33
 
 
-[1.41.0]: https://github.com/auto-differentiation/QuantLib-Risks-Py/compare/v1.33.3...v1.41.0
+[1.41.0]: https://github.com/auto-differentiation/QuantLibAAD-Py/compare/v1.33.3...v1.41.0
 
 [1.33.3]: https://github.com/auto-differentiation/QuantLib-Risks-Py/compare/v1.33.2...v1.33.3
 

CMakeLists.txt

@@ -1,8 +1,8 @@
 ##############################################################################
-#   CMake file for QuantLib-Risks, driven by scikit-build-core (pyproject.toml).
+#   CMake file for QuantLibAAD, driven by scikit-build-core (pyproject.toml).
 #   Keep the version in sync with pyproject.toml.
 #
-#  This file is part of QuantLib-Risks, a Python wrapper for QuantLib enabled
+#  This file is part of QuantLibAAD, a Python wrapper for QuantLib enabled
 #  for risk computation using automatic differentiation. It uses XAD,
 #  a fast and comprehensive C++ library for automatic differentiation.
 #

CONTRIBUTING.md

@@ -7,12 +7,12 @@ Note that this fork is importing all changes from the QuantLib-SWIG repository o
 release. Changes related to QuantLib's own Python bindings will be included in each new
 release. 
 Contributions to this repository should only be made if they are related to building
-the Python bindings for QuantLib-Risks (enabled with XAD).
+the Python bindings for QuantLibAAD (enabled with XAD).
 
 1.  Fork, then clone the repository with its submodules:
 
 ```bash
-git clone --recurse-submodules https://github.com/yourusername/QuantLib-Risks-Py.git
+git clone --recurse-submodules https://github.com/yourusername/QuantLibAAD-Py.git
 ```
 
 2.  Follow the [Build Instructions](#build-instructions) below to build the software.
@@ -54,7 +54,7 @@ The package is built in one step by [scikit-build-core](https://scikit-build-cor
 (see `pyproject.toml`): CMake builds QuantLib as a static library together with
 [QuantLibAAD](https://github.com/auto-differentiation/QuantLibAAD) from the `lib/` submodules,
 against [XAD](https://github.com/auto-differentiation/xad) from the installed
-[xad](https://pypi.org/project/xad/) package (`xad.get_cmake_dir()`), then the SWIG module from `SWIG/` and `Python/QuantLib_Risks/`.
+[xad](https://pypi.org/project/xad/) package (`xad.get_cmake_dir()`), then the SWIG module from `SWIG/` and `Python/QuantLibAAD/`.
 
 Requirements: Python 3.10+, and a C++17 compiler.
 CMake, Ninja and SWIG are installed as build dependencies.
@@ -67,7 +67,7 @@ python -m venv .venv
 source .venv/bin/activate
 pip install -v . pytest
 # run the tests from outside the source tree, against the installed package
-cd /tmp && python -m pytest --import-mode=importlib /path/to/QuantLib-Risks-Py/Python/test
+cd /tmp && python -m pytest --import-mode=importlib /path/to/QuantLibAAD-Py/Python/test
 ```
 
 Notes:
@@ -88,8 +88,11 @@ Notes:
 -   Wheels for all supported Python versions are built with
     [cibuildwheel](https://cibuildwheel.pypa.io) (`pipx run cibuildwheel`, configured in
     `pyproject.toml`), the source distribution with `pipx run build --sdist`.
+-   `shim/` is the pure-Python `QuantLib-Risks` distribution, a deprecated alias that requires
+    `QuantLibAAD` and re-exports it as `QuantLib_Risks`. Build it with `pipx run build shim`
+    and keep its version and `QuantLibAAD` requirement in sync with `pyproject.toml`.
 
 
-[pr]: https://github.com/auto-differentiation/QuantLib-Risks/compare/
+[pr]: https://github.com/auto-differentiation/QuantLibAAD-Py/compare/
 
 [cla]: https://gist.github.com/auto-differentiation-dev/5c6121c3f341e2de710fa034e9ff3263

LICENSE.md

@@ -1,14 +1,14 @@
 # License Terms
 
-QuantLib-Risks is published under the AGPL, version 3, with the terms
+QuantLibAAD is published under the AGPL, version 3, with the terms
 [given below](#gnu-affero-general-public-license). 
 
 It contains code from [QuantLib](https://www.quantlib.org) 
 and is based on [QuantLib-SWIG](https://github.com/lballabio/QuantLib-SWIG), 
 which are shipped with a different (compatible) license.
 The license terms for these packages [are given below](#quantlib-swig-license). 
 
-## QuantLib-Risks License
+## QuantLibAAD License
 
 ### GNU AFFERO GENERAL PUBLIC LICENSE
 

Python/CMakeLists.txt

@@ -1,7 +1,7 @@
 ##############################################################################
 #  Main CMake file for the Python extension.
 #
-#  This file is part of QuantLib-Risks, a Python wrapper for QuantLib enabled
+#  This file is part of QuantLibAAD, a Python wrapper for QuantLib enabled
 #  for risk computation using automatic differentiation. It uses XAD,
 #  a fast and comprehensive C++ library for automatic differentiation.
 #

Python/QuantLibAAD/CMakeLists.txt

@@ -1,7 +1,7 @@
 ##############################################################################
 #  Build and install the SWIG binary module and the Python package.
 #
-#  This file is part of QuantLib-Risks, a Python wrapper for QuantLib enabled
+#  This file is part of QuantLibAAD, a Python wrapper for QuantLib enabled
 #  for risk computation using automatic differentiation. It uses XAD,
 #  a fast and comprehensive C++ library for automatic differentiation.
 #

Python/QuantLibAAD/__init__.py

@@ -3,16 +3,16 @@
  Copyright (C) 2000, 2001, 2002, 2003 RiskMap srl
  Copyright (C) 2024 Xcelerit Computing Limited.
 
- This file is part of QuantLib-Risks, a Python wrapper for QuantLib enabled
+ This file is part of QuantLibAAD, a Python wrapper for QuantLib enabled
  for risk computation using automatic differentiation. It uses XAD,
  a fast and comprehensive C++ library for automatic differentiation.
 
- QuantLib-Risks and XAD are free software: you can redistribute it and/or modify
+ QuantLibAAD and XAD are free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as published
  by the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
- QuantLib-Risks is distributed in the hope that it will be useful,
+ QuantLibAAD is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Affero General Public License for more details.

Python/QuantLibAAD/converters.cpp

@@ -2,7 +2,7 @@
  *   Type converters and checks for the SWIG interface, interacting with XAD's
  *   Pybind11 based bindings.
  *
- *  This file is part of QuantLib-Risks, a Python wrapper for QuantLib enabled
+ *  This file is part of QuantLibAAD, a Python wrapper for QuantLib enabled
  *  for risk computation using automatic differentiation. It uses XAD,
  *  a fast and comprehensive C++ library for automatic differentiation.
  *

Python/QuantLibAAD/converters.hpp

@@ -2,7 +2,7 @@
  *   Type converters and checks for the SWIG interface, interacting with XAD's
  *   Pybind11 based bindings.
  *
- *  This file is part of QuantLib-Risks, a Python wrapper for QuantLib enabled
+ *  This file is part of QuantLibAAD, a Python wrapper for QuantLib enabled
  *  for risk computation using automatic differentiation. It uses XAD,
  *  a fast and comprehensive C++ library for automatic differentiation.
  *

Python/examples/american-option.py

@@ -19,16 +19,16 @@
 # Copyright (©) 2004, 2005, 2006, 2007 StatPro Italia srl
 # Copyright (©) 2024 Xcelerit Computing Limited.
 #
-# This file is part of QuantLib-Risks, a Python wrapper for QuantLib enabled
+# This file is part of QuantLibAAD, a Python wrapper for QuantLib enabled
 # for risk computation using automatic differentiation. It uses XAD,
 # a fast and comprehensive C++ library for automatic differentiation.
 #
-# QuantLib-Risks and XAD are free software: you can redistribute it and/or modify
+# QuantLibAAD and XAD are free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published
 # by the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
 #
-# QuantLib-Risks is distributed in the hope that it will be useful,
+# QuantLibAAD is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Affero General Public License for more details.