Update docs Riskfolio-XL

LICENSE-XL.txt

@@ -0,0 +1,38 @@
+RISKFOLIO-XL END-USER LICENSE AGREEMENT 
+
+IMPORTANT PLEASE READ THE TERMS AND CONDITIONS OF THIS LICENSE AGREEMENT CAREFULLY BEFORE CONTINUING WITH THIS PROGRAM INSTALL OR EXECUTION:
+RISKFOLIO-XL End-User License Agreement ("EULA") is a legal agreement between you (either an individual or a single entity) and ORENJI EIRL, a Peruvian company (ORENJI), for the ORENJI SOFTWARE(s) identified above which may include associated software components, media, printed materials, and "online" or electronic documentation ("SOFTWARE"). By installing, copying, or otherwise using the SOFTWARE, you agree to be bound by the terms of this EULA. This license agreement represents the entire agreement concerning the program between you and ORENJI, (referred to as "licenser"), and it supersedes any prior proposal, representation, or understanding between the parties. If you do not agree to the terms of this EULA, do not install or use the SOFTWARE. 
+The SOFTWARE is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. The SOFTWARE is licensed, not sold.
+
+1. GRANT OF LICENSE. 
+Subject to Your compliance with Your obligations under this Agreement, for the Term of this Agreement, ORENJI hereby grants to You, and You hereby accept from ORENJI, a non-exclusive, non-transferable, non-sublicensable, non-assignable, revocable, limited right and license to Use the SOFTWARE on a compatible computer (not exceeding one concurrent user). 
+1.1 Installation and Use. ORENJI grants you the right to install and use copies of the SOFTWARE on your computer running a validly licensed copy of the operating system for which the SOFTWARE was designed. The SOFTWARE runs on Microsoft Excel for Windows and requires a valid installation of PyXLL package and PyXLL add-in.   
+1.2 Backup Copies. You may also make copies of the SOFTWARE as may be necessary for backup and archival purposes.
+1.3 Trial copy. You may Use a Trial Copy of the SOFTWARE for evaluation only, in order to determine whether the program meets Your needs before purchasing it. Upon Your purchase of Purchased Copy of the SOFTWARE, Your evaluation period will automatically terminate, and You will be governed by the terms of this Agreement applicable to Purchased Copies of the SOFTWARE.
+1.4 Purchased copy. When You purchase a License to the SOFTWARE, You will receive a License Number which will activate Your Purchased Copy. You may not publish or distribute this License Number by any means without direct authorization from ORENJI. If You do, Your License to Use the Software, and this Agreement, shall automatically terminate without notice to You, You must remove all installed copies of the Software from Your Computer(s), and You may be liable for legal damages for continued Use of the SOFTWARE. If You purchased a corporate License to Use the SOFTWARE, You agree not to install or Use the SOFTWARE on more computers than the number included in Your License.
+1.5 On-line license validation. An internet connection is required to authenticate the SOFTWARE and verify Your license. ORENJI reserves the right to validate Your license through subsequent online authentications. If ORENJI determines Your license is not valid or does not correspond to Your computer, You may not be able to use the SOFTWARE. If you disable or otherwise tamper with the technical protection measures, the SOFTWARE may not function properly and You will have materially beached this agreement.
+
+2. DESCRIPTION OF OTHER RIGHTS AND LIMITATIONS.
+2.1 Maintenance of Copyright Notices.
+You must not remove or alter any copyright notices on any and all copies of the SOFTWARE.
+2.2 Distribution. You may not distribute registered copies of the SOFTWARE to third parties.
+2.3 Prohibition on Reverse Engineering, Decompilation, and Disassembly. You may not reverse engineer, decompile, or disassemble the SOFTWARE, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.
+2.4 Separation of Components. Software is licensed as a single product. Its components may not be separated for use on more than one computer. 
+2.5 Rental. You may not rent, lease, or lend the SOFTWARE.
+2.6 Support Services. ORENJI may provide you with support services related to the SOFTWARE ("Support Services"). Any supplemental software code provided to you as part of the Support Services shall be considered part of the SOFTWARE and subject to the terms and conditions of this EULA. 
+2.6 Compliance with Applicable Laws. You must comply with all applicable laws regarding use of the SOFTWARE.
+
+3. TERMINATION 
+Without prejudice to any other rights, ORENJI may terminate this EULA if you fail to comply with the terms and conditions of this EULA. In such event, you must destroy all copies of the SOFTWARE in your possession.
+
+4. COPYRIGHT
+All rights, all title, all interest, all trademarks and all copyrights in and pertaining to the Software, including but not limited to all images, photographs, animations, video, audio, music, text, data, computer code, algorithms, and information, are owned by ORENJI or its affiliated companies. The SOFTWARE is protected by U.S. and international copyright, trademarks, and other intellectual property laws and treaty provisions. You must treat the SOFTWARE like any other copyrighted product for archival purposes, and You may not copy the printed materials and documentation accompanying the SOFTWARE. You may not remove, modify or alter any ORENJI copyright or trademark notice from any part of the SOFTWARE. Unauthorized use or copying of the SOFTWARE, including SOFTWARE that has been modified, merged, or included with other software, is expressly forbidden. 
+
+5. DISCLAIMER OF WARRANTIES
+THE SOFTWARE IS LICENSED "AS IS, WITH ALL FAULTS" AND YOU AND YOUR AUTHORIZED END USERS ARE ASSUMING ALL RISK AS TO ITS QUALITY AND PERFORMANCE.  ORENJI DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH RESPECT TO THE SOFTWARE, INCLUDING BUT NOT LIMITED TO CONDITION, CONFORMITY TO ANY REPRESENTATION OR DESCRIPTION, COMPATIBILITY WITH ALL HARDWARE AND SOFTWARE CONFIGURATIONS, THE EXISTENCE OF ANY LATENT OR PATENT DEFECTS, NEGLIGENCE, AND THE WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR USE OR PURPOSE. FURTHER, YOU ACKNOWLEDGE AND AGREE THAT (1) ORENJI DOES NOT MAKE ANY WARRANTY THAT THE SOFTWARE AND DOCUMENTATION ARE WITHOUT DEFECT OR ERROR, OR THAT ALL PRODUCT ERRORS WILL BE CORRECTED; AND (2) ORENJI DOES NOT MAKE ANY WARRANTY AS TO ANY RESULTS THAT MAY BE OBTAINED BY USE OF THE SOFTWARE.
+
+6. INDEMNITY
+You agree to indemnify and hold harmless ORENJI, its subsidiaries, and their current and former shareholders, directors, officers, employees, and agents from and against any and all demands, judgments, losses, costs, expenses, obligations, liabilities, damages, fines, recoveries and deficiencies, including without limitation interest, penalties, reasonable attorney's fees and costs, which any such party may incur or suffer which are based upon, arising from, or related to the Use of the SOFTWARE provided to You, or the alleged or actual breach of any of Your obligations under this Agreement.
+
+7. LIMITATION OF LIABILITY
+In no event shall ORENJI be liable for any damages (including, without limitation, lost profits, business interruption, or lost information) rising out of 'Authorized Users' use of or inability to use the SOFTWARE, even if ORENJI has been advised of the possibility of such damages. In no event will ORENJI be liable for loss of data or for indirect, special, incidental, consequential (including lost profit), or other damages based in contract, tort or otherwise. ORENJI shall have no liability with respect to the content of the SOFTWARE or any part thereof, including but not limited to errors or omissions contained therein, libel, infringements of rights of publicity, privacy, trademark rights, business interruption, personal injury, loss of privacy, moral rights or the disclosure of confidential information. 

docs/source/excel.rst

@@ -0,0 +1,136 @@
+############
+Riskfolio-XL
+############
+
+**Riskfolio-Lib add-in for Microsoft Excel**
+
+Description
+===========
+
+Riskfolio-XL is a Microsoft Excel add-in based on `PyXLL <https://www.pyxll.com/index.html>`_ library, that allows users use the same features of Riskfolio-Lib in Excel through Riskfolio-XL spreadsheet functions. Its objective is to help non-programming users to build investment portfolios based on mathematically complex models with low effort and to support the maintenance and further development of Riskfolio-Lib.
+
+Installation
+============
+
+Riskfolio-XL is only available on Windows and it requires a valid installation of PyXLL package and PyXLL add-in. To install PyXLL and PyXLL add-in, you can find the PyXLL installation instructions in the following `link <https://www.pyxll.com/docs/userguide/installation/firsttime.html>`_.
+
+After installing the PyXLL package and PyXLL add-in, the latest stable release of Riskfolio-XL (and older versions) can be installed from PyPI:
+
+  ::
+    
+      pip install riskfolio-xl
+
+
+After installing the Riskfolio-XL package you will have access to the **TRIAL COPY** of Riskfolio-XL, this version is limited to work only with portfolios of 7 assets and risk factor models of 3 risk factors.
+
+To access the **PURCHASED COPY** of Riskfolio-XL, you need a valid license. To get a Riskfolio-XL license you have to purchase it paying a monthly or annual subscription:
+
+.. raw:: html
+
+   <style>
+   .tab {
+   overflow: hidden;
+   border: 1px solid #ccc;
+   background-color: #f1f1f1;
+   }
+
+   /* Style the buttons inside the tab */
+   .tab button {
+   background-color: inherit;
+   float: left;
+   border: none;
+   outline: none;
+   cursor: pointer;
+   padding: 14px 16px;
+   transition: 0.3s;
+   font-size: 17px;
+   }
+
+   /* Change background color of buttons on hover */
+   .tab button:hover {
+   background-color: #ddd;
+   }
+
+   /* Create an active/current tablink class */
+   .tab button.active {
+   background-color: #ccc;
+   }
+
+   /* Style the tab content */
+   .tabcontent {
+   display: none;
+   padding: 6px 12px;
+   border: 1px solid #ccc;
+   border-top: none;
+   }
+   </style>
+   <div class="tab">
+   <button class="tablinks" onclick="openTab(event, 'paypal-container-DLABCNSPX8LZL')" id="defaultOpen">Monthly License</button>
+   <button class="tablinks" onclick="openTab(event, 'paypal-container-KKZBWK6JK8ZDA')">Annual License</button>
+   </div>
+
+   <script src="https://www.paypal.com/sdk/js?client-id=BAA_FQBdhZjxYgI2N5DACAiN0--Lkv3sO9Kj0LKlFq9BWpNha13pFGIjK3X9qumuLmkh9oOPFdoSb-mJvc&components=hosted-buttons&disable-funding=venmo&currency=USD"></script>
+   <div id="paypal-container-DLABCNSPX8LZL" class="tabcontent"></div>
+   <div id="paypal-container-KKZBWK6JK8ZDA" class="tabcontent"></div>
+   <script>
+   paypal.HostedButtons({
+      hostedButtonId: "DLABCNSPX8LZL",
+   }).render("#paypal-container-DLABCNSPX8LZL")
+
+   paypal.HostedButtons({
+      hostedButtonId: "KKZBWK6JK8ZDA",
+   }).render("#paypal-container-KKZBWK6JK8ZDA")
+
+   function openTab(evt, tabId) {
+   var i, tabcontent, tablinks;
+   tabcontent = document.getElementsByClassName("tabcontent");
+   for (i = 0; i < tabcontent.length; i++) {
+      tabcontent[i].style.display = "none";
+   }
+   tablinks = document.getElementsByClassName("tablinks");
+   for (i = 0; i < tablinks.length; i++) {
+      tablinks[i].className = tablinks[i].className.replace(" active", "");
+   }
+   document.getElementById(tabId).style.display = "block";
+   evt.currentTarget.className += " active";
+   }
+
+   document.getElementById("defaultOpen").click();
+   </script>
+   </br>
+
+**After paying, you need to send us an email to** `orenji.eirl@gmail.com <orenji.eirl@gmail.com>`_ **and you will receive your Riskfolio-XL license (within 24 hours) and a discount code to purchase the PyXLL package.**
+
+Then, you have to add your Riskfolio-XL license to the pyxll.cfg file:
+
+* First, click on About PyXLL button of Riskfolio-XL add-in as shown in the image below:
+
+.. image:: images/Images-XL/Installation_1.png
+
+* Then, click on the config file link as shown in the image below:
+
+.. image:: images/Images-XL/Installation_2.png
+
+* Finally, write your Riskfolio-XL license in the riskfolio_xl_key parameter as shown in the image below:
+
+.. image:: images/Images-XL/Installation_3.png
+
+Citing
+======
+
+If you use Riskfolio-Lib for published work, please use the following BibTeX entry:
+
+::
+
+    @misc{riskfolioxl,
+          author = {Dany Cajas},
+          title = {Riskfolio-LXLib (0.1.0)},
+          year  = {2024},
+          url   = {https://riskfolio-lib.readthedocs.io/en/latest/excel.html},
+          }
+
+
+License
+=======
+
+.. include:: ../../LICENSE-XL.txt

docs/source/index.rst

@@ -322,6 +322,7 @@ Contents
     :maxdepth: 1
 
     Install <install>
+    Riskfolio-XL <excel>
     Portfolio Models <portfolio>
     Hierarchical Clustering Models <hcportfolio>
     Parameters Estimation <parameters>

pyproject.toml

@@ -2,13 +2,6 @@
 requires = [
     "oldest-supported-numpy",
     "pybind11>=2.10.1",
-#    "numpy>=1.18,<1.19; python_version=='3.8'",
-#    "numpy>=1.19,<1.20; python_version=='3.9' and (platform_machine!='arm64' or platform_system!='Darwin')",
-#    "numpy>=1.21.4,<1.22; python_version=='3.9' and (platform_machine=='arm64' and platform_system=='Darwin')",
-#    "numpy>=1.21,<1.22; python_version=='3.10' and (platform_machine!='arm64' or platform_system!='Darwin')",
-#    "numpy>=1.21.4,<1.22; python_version=='3.10' and (platform_machine=='arm64' and platform_system=='Darwin')",
-#    "numpy>=1.23.4,<1.24; python_version=='3.11'",
-#    "numpy>=1.26.4; python_version=='3.12'",
     "scipy >= 1.1.0",
     "setuptools>68.1.0",
     "wheel"