fixup

Author: nikohansen

.github/workflows/python-package.yml

@@ -31,6 +31,8 @@ jobs:
         python -m pip install ruff
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         python -m pip install moarchiving
+        mkdir src
+        ln -s cma src/cma
         python -m pip install .  # or install numpy and further dependencies?
     - name: Lint with flake8
       run: |

README.md

@@ -22,9 +22,15 @@ Zenodo: 34 points to the latest release (v4.4.2: https://zenodo.org/records/1835
 
 ``pycma`` is a Python implementation of [CMA-ES](http://cma-es.github.io/) and some related numerical optimization tools.
 
-The [CMA-ES](http://cma-es.github.io) ([Covariance Matrix Adaptation Evolution Strategy](https://en.wikipedia.org/wiki/CMA-ES)) is a stochastic derivative-free numerical optimization
+The [CMA-ES](http://cma-es.github.io) ([Covariance Matrix Adaptation Evolution Strategy](https://en.wikipedia.org/wiki/CMA-ES)) is a randomized derivative-free numerical optimization
 algorithm for difficult (non-convex, ill-conditioned, multi-modal, rugged, noisy) optimization
 problems in continuous and mixed-integer search spaces.
+This package provides the CMA-ES algorithm and includes the handling of
+
+* bound constraints via the ``'bounds' = [lower, upper]`` option
+* linear and nonlinear constraints via the `constraints` argument to `fmin2` or `fmin_con2`
+* noise via ``noise_handler=True`` as argument to `fmin2`
+* integer variables for mixed-integer problems via the ``'integer_variables'=index_list`` option
 
 ## Documentation and Getting Started (Links)
 
@@ -104,9 +110,9 @@ either of these with ``sudo``.
     same time in two subplots.
   - New:
     - Provide the two (by far) most useful statistical tests with a tidy
-      interface in `.utilities.math.test...`
+      interface in ``cma.utilities.math.test...``
     - Provide a `more_algorithms` sub-package containing `purecma` and `CompactGA`.
-    - Provide a provisional `experimentation` module.
+    - Provide a provisional `experimentation` module (requires `import cma.experimentation`).
   - A few smaller fixes and improvements.
 
 * [Release ``4.4.2``](https://github.com/CMA-ES/pycma/releases/tag/r4.4.2)

pyproject.toml

@@ -60,11 +60,11 @@ classifiers = [
 # packages = ["cma", "cma.utilities"]  # fails when they are in an src/ folder
 include-package-data = false  # true is default, false doesn't change anything
 
-# [tool.setuptools.packages.find]  # for where=. works only in a clean folder
-# without any directives: finds src folder implying a standard (nonflat) layout
-# # where = ["src"]  # this doesn't work, it always takes the root too?
-# include = ["cma*"]  # cma/* ?
-# exclude = ["notebooks*"]  # , "cma_*" ?
+[tool.setuptools.packages.find]  # for where=. works only in a clean folder
+# # without any directives: finds src folder implying a standard (nonflat) layout
+# # # where = ["src"]  # this doesn't work, it always takes the root too?
+# # include = ["cma*"]  # cma/* ?
+exclude = ["notebooks*"]  # , "cma_*" ?
 
 # namespaces = false
 

setup-howto.py

@@ -43,7 +43,7 @@
 Make and check the distribution assuming a clean src/ folder (ln -s cma src/cma, was: from a (usual) dirty code folder ==> install-folder)::
 
     python -m build > dist_call_output.txt; less dist_call_output.txt
-    git tag last-build  # not sure whether this is useful
+    git tag -f last-build  # not sure whether this is useful
 
     # was: ./script-prepare-distribution.sh    
     #     ==>
@@ -58,7 +58,7 @@
 
     twine check dist/*
     tar -tf dist/cma-4.4.0.tar.gz | tree --fromfile | less
-                #   ==> 6 directories, 40 files, check that the distribution folders are clean
+                #   ==> 7 directories, 40 files, check that the distribution folders are clean
                 #   was: ==> 5 directories, 36 files, check that the distribution folders are clean
 
 # see https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html#summary