diff --git a/.ci_support/run_docker_linux.sh b/.ci_support/run_docker_linux.sh index 77ed331..07274db 100755 --- a/.ci_support/run_docker_linux.sh +++ b/.ci_support/run_docker_linux.sh @@ -8,7 +8,7 @@ cmake -DCMAKE_INSTALL_PREFIX=~/.local \ -DCMAKE_UNITY_BUILD=ON -DCMAKE_UNITY_BUILD_BATCH_SIZE=32 \ -DCMAKE_CXX_FLAGS="-Wall -Wextra -Wpedantic -Wshadow -Werror -D_GLIBCXX_ASSERTIONS" \ -DSWIG_COMPILE_FLAGS="-O1 -Wno-unused-parameter -Wno-shadow" \ - -DSPHINX_FLAGS="-W -T -j4" \ + -DUSE_SPHINX=ON -DSPHINX_FLAGS="-W -T -j4" \ /io make install make tests diff --git a/CMakeLists.txt b/CMakeLists.txt index 12c6a24..f298668 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required (VERSION 3.13) option (BUILD_PYTHON "Build the python module for the library" ON) -option (USE_SPHINX "Use sphinx for documentation" ON) +option (USE_SPHINX "Use sphinx for documentation" OFF) option (BUILD_SHARED_LIBS "Build shared libraries" ON) # By default, build in Release mode. Must appear before project() command @@ -29,9 +29,6 @@ endif() find_package (OpenTURNS CONFIG REQUIRED) message (STATUS "Found OpenTURNS: ${OPENTURNS_ROOT_DIR} (found version \"${OPENTURNS_VERSION_STRING}\")") -if (NOT DEFINED OPENTURNS_PYTHON_MODULE_PATH) - set (OPENTURNS_PYTHON_MODULE_PATH ${OPENTURNS_PYTHON3_MODULE_PATH}) -endif () if (NOT BUILD_SHARED_LIBS) list ( APPEND OTROBOPT_DEFINITIONS "-DOTROBOPT_STATIC" ) @@ -52,16 +49,14 @@ set (OTROBOPT_DATA_PATH ${CMAKE_INSTALL_DATAROOTDIR}) set (OTROBOPT_CONFIG_CMAKE_PATH ${CMAKE_INSTALL_LIBDIR}/cmake/otrobopt) set (OTROBOPT_DOC_PATH ${CMAKE_INSTALL_DOCDIR}) -set (CMAKE_CXX_STANDARD 11) - if (BUILD_PYTHON) find_package (SWIG 3) include (${SWIG_USE_FILE}) - if (CMAKE_VERSION VERSION_LESS 3.24) - find_package (Python 3.5 COMPONENTS Interpreter Development) + if (CMAKE_VERSION VERSION_LESS 3.28) + find_package (Python 3.6 COMPONENTS Interpreter Development) else () - find_package (Python 3.5 COMPONENTS Interpreter Development.Module) + find_package (Python 3.6 COMPONENTS Interpreter Development.Module Development.SABIModule) endif () if (Python_FOUND) @@ -75,7 +70,8 @@ if (BUILD_PYTHON) find_program (SPHINX_EXECUTABLE NAMES sphinx-build DOC "Sphinx Documentation Builder (sphinx-doc.org)") find_python_module (numpydoc) find_python_module (sphinx_gallery) - if (SPHINX_EXECUTABLE AND NUMPYDOC_FOUND AND SPHINX_GALLERY_FOUND AND MATPLOTLIB_FOUND) + find_python_module (sphinx_copybutton) + if (SPHINX_EXECUTABLE AND NUMPYDOC_FOUND AND SPHINX_GALLERY_FOUND AND SPHINX_COPYBUTTON_FOUND AND MATPLOTLIB_FOUND) find_python_module (sphinx) endif () if (NOT SPHINX_FOUND) @@ -132,7 +128,7 @@ endmacro ( ot_add_current_dir_to_include_dirs ) set ( CPACK_PACKAGE_NAME ${PACKAGE_NAME} ) set ( CPACK_PACKAGE_VERSION_MAJOR 0 ) -set ( CPACK_PACKAGE_VERSION_MINOR 14 ) +set ( CPACK_PACKAGE_VERSION_MINOR 15 ) set ( CPACK_PACKAGE_VERSION_PATCH ) set ( CPACK_SOURCE_GENERATOR "TGZ;TBZ2" ) set (CPACK_BINARY_STGZ OFF CACHE BOOL "STGZ") diff --git a/ChangeLog b/ChangeLog index ea84b60..8cb6c5e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ += 0.15 release (wip) + + * Maintenance + = 0.14 release (2024-05-12) * Maintenance diff --git a/VERSION b/VERSION index 948a547..2856407 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.14 +0.15 diff --git a/distro/debian/changelog b/distro/debian/changelog index af6c1de..8854e9b 100644 --- a/distro/debian/changelog +++ b/distro/debian/changelog @@ -1,4 +1,4 @@ -otrobopt (0.14-0.1) unstable; urgency=low +otrobopt (0.15-0.1) unstable; urgency=low * Non-maintainer upload. * Initial release. diff --git a/distro/rpm/otrobopt.spec b/distro/rpm/otrobopt.spec index cf15c9f..808ffb8 100644 --- a/distro/rpm/otrobopt.spec +++ b/distro/rpm/otrobopt.spec @@ -20,7 +20,7 @@ FFLAGS="${FFLAGS:-%optflags}" ; export FFLAGS ; \ -DBUILD_SHARED_LIBS:BOOL=ON Name: otrobopt -Version: 0.14 +Version: 0.15 Release: 0%{?dist} Summary: OpenTURNS module Group: System Environment/Libraries diff --git a/python/doc/_templates/MeasureEvaluation.rst_t b/python/doc/_templates/MeasureEvaluation.rst_t index 5d77471..70fd92b 100644 --- a/python/doc/_templates/MeasureEvaluation.rst_t +++ b/python/doc/_templates/MeasureEvaluation.rst_t @@ -72,6 +72,7 @@ .. currentmodule:: {{ module }} .. autoclass:: {{ objname }} + :exclude-members: __call__, thisown {% block methods %} .. automethod:: __init__ diff --git a/python/doc/_templates/class.rst_t b/python/doc/_templates/class.rst_t index 0630f29..08f24fe 100644 --- a/python/doc/_templates/class.rst_t +++ b/python/doc/_templates/class.rst_t @@ -4,6 +4,7 @@ .. currentmodule:: {{ module }} .. autoclass:: {{ objname }} + :exclude-members: __call__, thisown {% block methods %} .. automethod:: __init__ diff --git a/python/doc/conf.py.in b/python/doc/conf.py.in index 2e5d274..9e9f775 100644 --- a/python/doc/conf.py.in +++ b/python/doc/conf.py.in @@ -67,6 +67,9 @@ imgmath_embed = True extensions.append('matplotlib.sphinxext.plot_directive') +extensions.append('sphinx_copybutton') +copybutton_prompt_text = ">>> " + extensions.append('sphinx_gallery.gen_gallery') sphinx_gallery_conf = { 'examples_dirs': ['examples'], # path to example scripts @@ -88,7 +91,7 @@ master_doc = 'index' # General information about the project. project = u'OTRobOpt' -copyright = u'2015-2018 Airbus-EDF-IMACS-Phimeca' +copyright = u'2015-2024 Airbus-EDF-IMACS-Phimeca' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -287,3 +290,6 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' + +# If true, Sphinx will warn about all references where the target cannot be found. +nitpicky = True diff --git a/python/src/SubsetInverseSampling_doc.i.in b/python/src/SubsetInverseSampling_doc.i.in index cd7bbca..d5791d6 100644 --- a/python/src/SubsetInverseSampling_doc.i.in +++ b/python/src/SubsetInverseSampling_doc.i.in @@ -3,9 +3,8 @@ Parameters ---------- -event : :class:`~openturns.Event` - Event we are computing the probability of. The threshold of the event is - not used. +event : :class:`~openturns.RandomVector` + Event we are computing the probability of. The threshold of the event is not used. targetProbability : float The wanted final probability. proposalRange : float, optional @@ -78,31 +77,31 @@ Create a performance function with an associated distribution. >>> mean = ot.Point([7., 2.]) >>> sigma = ot.Point(dim, 1.0) >>> R = ot.IdentityMatrix(dim) ->>> myDistribution = ot.Normal(mean, sigma, R) ->>> vect = ot.RandomVector(myDistribution) +>>> distribution = ot.Normal(mean, sigma, R) +>>> vect = ot.RandomVector(distribution) >>> output = ot.CompositeRandomVector(limitState, vect) Create an event with a fictional threshold value which will not be used. ->>> myEvent = ot.ThresholdEvent(output, ot.Less(), 0.) +>>> event = ot.ThresholdEvent(output, ot.Less(), 0.) Define the target probability for which the threshold will be computed. >>> targetProbability = 0.0002 ->>> mySS = otrobopt.SubsetInverseSampling(myEvent, targetProbability) ->>> mySS.setMaximumOuterSampling(10000) ->>> mySS.run() +>>> algo = otrobopt.SubsetInverseSampling(event, targetProbability) +>>> algo.setMaximumOuterSampling(10000) +>>> algo.run() Get some results. ->>> resultSS = mySS.getResult() ->>> pf = resultSS.getProbabilityEstimate() ->>> threshold = mySS.getThresholdPerStep()[-1] ->>> threshold_cl = mySS.getThresholdConfidenceLength(0.90) +>>> result = algo.getResult() +>>> pf = result.getProbabilityEstimate() +>>> threshold = algo.getThresholdPerStep()[-1] +>>> threshold_cl = algo.getThresholdConfidenceLength(0.90) See also -------- -openturns.Simulation" +openturns.EventSimulation" // --------------------------------------------------------------------------- diff --git a/python/src/__init__.py b/python/src/__init__.py index cae9b4a..e500103 100644 --- a/python/src/__init__.py +++ b/python/src/__init__.py @@ -15,4 +15,4 @@ from .otrobopt import * -__version__ = '0.14' +__version__ = '0.15'