optiprofiler 1.0.dev2__tar.gz → 1.0.1__tar.gz

{optiprofiler-1.0.dev2/python/optiprofiler.egg-info → optiprofiler-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optiprofiler
-Version: 1.0.dev2
+Version: 1.0.1
 Summary: Benchmarking optimization solvers
 Author-email: Cunxin Huang <cun-xin.huang@connect.polyu.hk>, "Tom M. Ragonneau" <tom.ragonneau@polyu.edu.hk>, Zaikun Zhang <zaikun.zhang@polyu.edu.hk>
 Maintainer-email: Cunxin Huang <cun-xin.huang@connect.polyu.hk>, "Tom M. Ragonneau" <tom.ragonneau@polyu.edu.hk>, Zaikun Zhang <zaikun.zhang@polyu.edu.hk>
@@ -72,6 +72,7 @@ Requires-Dist: sphinx-book-theme==1.1.2; extra == "doc"
 Requires-Dist: sphinx-design==0.5.0; extra == "doc"
 Requires-Dist: sphinxcontrib-bibtex==2.6.2; extra == "doc"
 Requires-Dist: sphinxcontrib-matlabdomain; extra == "doc"
+Requires-Dist: sphinxext-opengraph; extra == "doc"
 Provides-Extra: extra
 Requires-Dist: pycutest>=1.6.1; extra == "extra"
 Provides-Extra: tests
@@ -84,24 +85,48 @@ OptiProfiler: a platform for benchmarking optimization solvers
 
 |docs_badge| |codecov_badge|
 
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml
-.. image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml/badge.svg
-   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml
+|py_unit| |py_multi_os| |py_random| |py_stress|
+
+|ml_unit| |ml_multi_os| |ml_random| |ml_stress|
 
 .. |docs_badge| image:: https://img.shields.io/readthedocs/optiprofiler/latest?logo=readthedocs&style=for-the-badge
     :target: http://www.optprof.com
 .. |codecov_badge| image:: https://img.shields.io/codecov/c/github/optiprofiler/optiprofiler?style=for-the-badge&logo=codecov
    :target: https://app.codecov.io/github/optiprofiler/optiprofiler/tree/main
+.. |py_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml
+.. |py_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml
+.. |py_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml
+.. |py_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml
+.. |ml_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml
+.. |ml_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml
+.. |ml_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml
+.. |ml_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml
 
-MATLAB version is available.
-----------------------------
+🌐 **Website:** `www.optprof.com <https://www.optprof.com>`_
 
-To install the MATLAB version, please do the following:
+Python
+------
+
+Install OptiProfiler via pip:
+
+.. code-block:: bash
+
+    pip install optiprofiler
+
+.. note::
+
+    OptiProfiler includes the `S2MPJ <https://github.com/GrattonToint/S2MPJ>`_ problem library by default. If you also want to use the `PyCUTEst <https://jfowkes.github.io/pycutest/>`_ problem library (available on Linux and macOS only), please follow the `PyCUTEst installation guide <https://jfowkes.github.io/pycutest/_build/html/install.html>`_.
+
+MATLAB
+------
 
 1. Clone the repository using the following command:
 
@@ -114,6 +139,3 @@ To install the MATLAB version, please do the following:
 .. code-block:: matlab
 
     setup
-
-Python version is under development.
-------------------------------------

optiprofiler-1.0.1/README.rst

@@ -0,0 +1,59 @@
+OptiProfiler: a platform for benchmarking optimization solvers
+==============================================================
+
+|docs_badge| |codecov_badge|
+
+|py_unit| |py_multi_os| |py_random| |py_stress|
+
+|ml_unit| |ml_multi_os| |ml_random| |ml_stress|
+
+.. |docs_badge| image:: https://img.shields.io/readthedocs/optiprofiler/latest?logo=readthedocs&style=for-the-badge
+    :target: http://www.optprof.com
+.. |codecov_badge| image:: https://img.shields.io/codecov/c/github/optiprofiler/optiprofiler?style=for-the-badge&logo=codecov
+   :target: https://app.codecov.io/github/optiprofiler/optiprofiler/tree/main
+.. |py_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-unit_test.yml
+.. |py_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-test_multi-os.yml
+.. |py_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-random_test.yml
+.. |py_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/python-stress_test.yml
+.. |ml_unit| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-unit_test.yml
+.. |ml_multi_os| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-test_multi-os.yml
+.. |ml_random| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-random_test.yml
+.. |ml_stress| image:: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml/badge.svg
+   :target: https://github.com/optiprofiler/optiprofiler/actions/workflows/matlab-stress_test.yml
+
+🌐 **Website:** `www.optprof.com <https://www.optprof.com>`_
+
+Python
+------
+
+Install OptiProfiler via pip:
+
+.. code-block:: bash
+
+    pip install optiprofiler
+
+.. note::
+
+    OptiProfiler includes the `S2MPJ <https://github.com/GrattonToint/S2MPJ>`_ problem library by default. If you also want to use the `PyCUTEst <https://jfowkes.github.io/pycutest/>`_ problem library (available on Linux and macOS only), please follow the `PyCUTEst installation guide <https://jfowkes.github.io/pycutest/_build/html/install.html>`_.
+
+MATLAB
+------
+
+1. Clone the repository using the following command:
+
+.. code-block:: bash
+
+    git clone https://github.com/optiprofiler/optiprofiler.git
+
+2. In MATLAB, navigate to the folder where the source code is located, and you will see a file named ``setup.m``. Run the following command in the MATLAB command window:
+
+.. code-block:: matlab
+
+    setup

{optiprofiler-1.0.dev2 → optiprofiler-1.0.1}/pyproject.toml

@@ -57,6 +57,7 @@ doc = [
     "sphinx-design==0.5.0",
     "sphinxcontrib-bibtex==2.6.2",
     "sphinxcontrib-matlabdomain",
+    "sphinxext-opengraph",
 ]
 extra = ["pycutest>=1.6.1"]
 tests = [
@@ -114,3 +115,10 @@ markers = [
     "extra: mark test as requiring extra dependencies (pycutest)",
 ]
 norecursedirs = ["action_tests"]
+
+[tool.coverage.run]
+omit = [
+    "*/problem_libs/*",
+    "*/tests/*",
+    "*/action_tests/*",
+]

{optiprofiler-1.0.dev2 → optiprofiler-1.0.1}/python/optiprofiler/__init__.py

@@ -12,12 +12,13 @@
 #
 # Dev branch marker is: 'X.Y.dev' or 'X.Y.devN' where N is an integer.
 # 'X.Y.dev0' is the canonical version of 'X.Y.dev'.
-__version__ = '1.0.dev2'
+__version__ = '1.0.1'
 
 # Public API of the optiprofiler package
 from .opclasses import Feature, Problem, FeaturedProblem
 from .profiles import benchmark
 from .utils import show_versions
+from .plib_config import get_plib_config, set_plib_config
 
 __all__ = [
     'Problem',
@@ -25,4 +26,6 @@ __all__ = [
     'FeaturedProblem',
     'benchmark',
     'show_versions',
+    'get_plib_config',
+    'set_plib_config',
 ]

{optiprofiler-1.0.dev2 → optiprofiler-1.0.1}/python/optiprofiler/action_tests/random_test.py

@@ -7,6 +7,8 @@ This test is run by GitHub Actions workflows, not by pytest.
 import sys
 import os
 import platform
+import matplotlib
+matplotlib.use('Agg')
 import numpy as np
 from datetime import datetime
 

{optiprofiler-1.0.dev2 → optiprofiler-1.0.1}/python/optiprofiler/action_tests/stress_test.py

@@ -7,6 +7,8 @@ This test is run by GitHub Actions workflows, not by pytest.
 import sys
 import os
 import platform
+import matplotlib
+matplotlib.use('Agg')
 import numpy as np
 from datetime import datetime
 

{optiprofiler-1.0.dev2 → optiprofiler-1.0.1}/python/optiprofiler/action_tests/test_all_features.py

@@ -8,6 +8,8 @@ import sys
 import os
 import platform
 import time
+import matplotlib
+matplotlib.use('Agg')
 
 # Add parent directory to path for imports
 sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))))