openinterfaces 0.5.4__tar.gz

openinterfaces-0.5.4/.pytest_cache/README.md

@@ -0,0 +1,8 @@
+# pytest cache directory #
+
+This directory contains data from the pytest's cache plugin,
+which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
+
+**Do not** commit this to version control.
+
+See [the docs](https://docs.pytest.org/en/stable/how-to/cache.html) for more information.

openinterfaces-0.5.4/CMakeLists.txt

@@ -0,0 +1,60 @@
+cmake_minimum_required(VERSION 3.18)
+
+project(
+  oif-toy-example
+  LANGUAGES C CXX
+  VERSION 0.5.4)
+
+# Enforce using `-std=c11`, without any extensions like `gnu11`.
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+
+if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+  message("Disable optimizations for Debug build type")
+  string(PREPEND CMAKE_C_FLAGS_DEBUG "-O0 ")
+endif()
+
+# Incorporate additions by X/Open 7, that includes POSIX 17 additions and allow
+# to use things like the `M_PI` constant in the code without warnings from
+# static analyzers.
+add_compile_definitions(_XOPEN_SOURCE=700)
+
+# DOWNLOAD_EXTRACT_TIMESTAMP = TRUE
+if(POLICY CMP0135)
+  cmake_policy(SET CMP0135 NEW)
+endif()
+
+# Copy all built library targets to a common directory, so that it is easy to
+# find and load them.
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
+
+# when building, don't use the install RPATH already (but later on when
+# installing)
+set(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE)
+
+# Make sure that libraries can be found by the linker.
+set(CMAKE_INSTALL_RPATH "$ORIGIN")
+
+# Add additional cmake module to find packages.
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+
+add_subdirectory(vendor)
+
+add_subdirectory(common)
+add_subdirectory(dispatch)
+
+add_subdirectory(lang_python)
+
+if(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/oif")
+  add_subdirectory(oif)
+endif()
+if(IS_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/oif_impl")
+  add_subdirectory(oif_impl)
+endif()
+
+if(EXISTS examples/CMakeLists.txt)
+  add_subdirectory(examples)
+endif()
+
+enable_testing()
+add_subdirectory(tests)

openinterfaces-0.5.4/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2025, MaRDI Open Interfaces authors and contributors
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

openinterfaces-0.5.4/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: openinterfaces
+Version: 0.5.4
+Summary: Open Interfaces for improving Interoperability in Scientific Computing
+Author-Email: "Dmitry I. Kabanov" <dmitry.kabanov@uni-muenster.de>, Stephan Rave <stephan.rave@uni-muenster.de>, Mario Ohlberger <mario.ohlberger@uni-muenster.de>
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Other
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Project-URL: homepage, https://github.com/MaRDI4NFDI/open-interfaces
+Project-URL: documentation, https://mardi4nfdi.github.io/open-interfaces/
+Project-URL: issues, https://github.com/MaRDI4NFDI/open-interfaces/issues
+Project-URL: source, https://github.com/MaRDI4NFDI/open-interfaces
+Requires-Python: >=3.9
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: msgpack
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/MaRDI4NFDI/open-interfaces/refs/heads/main/assets/mardi-oif-logo.svg" width="40" style="vertical-align: text-bottom;" />
+MaRDI Open Interfaces
+</h1>
+
+[![QA](https://github.com/MaRDI4NFDI/open-interfaces/actions/workflows/qa.yaml/badge.svg)](https://github.com/MaRDI4NFDI/open-interfaces/actions/workflows/qa.yaml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13753666.svg)](https://doi.org/10.5281/zenodo.13753666)
+
+_MaRDI Open Interfaces_ is a project aiming to improve interoperability
+in scientific computing by removing two hurdles that computational scientists
+usually face in their daily work.
+
+These hurdles are the following.
+First, numerical solvers are often implemented in different programming
+languages.
+Second, these solvers have potentially significantly diverging interfaces
+in terms of function names, order of function arguments, and the invocation
+order.
+Therefore, when a computational scientist wants to switch from one solver
+to another, it could take non-negligible effort in code modification
+and testing for the correctness.
+
+_Open Interfaces_ aim to alleviate these problems by providing automatic data
+marshalling between different languages and a set of interfaces for typical
+numerical problems such as integration of differential equations and
+optimization.
+
+This project is the part of the [_Mathematical Research Data Initiative
+(MaRDI)_](https://mardi4nfdi.de).
+
+## Data flow
+
+![Architecture of the MaRDI Open Interfaces](https://media.githubusercontent.com/media/MaRDI4NFDI/open-interfaces/refs/heads/main/assets/arch.png)
+
+This figure shows the software architecture of the _MaRDI Open Interfaces_.
+There are two principal decoupled parts. The left part is user-facing
+and allows a user to request an implementation of some numerical procedure
+and then invoke different functions in this implementation to conduct
+computations using a unified interface (Gateway)
+that hides discrepancies between different implementations.
+The other part (on the right) is completely hidden from the user
+and works with an implementation of the interface.
+Particularly, it loads the implementation and its adapter and converts
+user data to the native data for the implementation.
+
+## Installation of Python bindings and implementations
+
+The Python bindings and implementations of the interfaces are available
+from [Python Package Index (PyPI)](https://pypi.org/)
+and can be installed using
+```shell
+pip install openinterfaces
+```
+
+## Run examples
+
+Examples are provided in the `examples` directory in this repository.
+Documentation explaining some of these examples is available here:
+<https://mardi4nfdi.github.io/open-interfaces/>.
+
+
+## Funding
+
+This work is funded by the _Deutsche Forschungsgemeinschaft_ (DFG, _German
+Research Foundation_) under Germany's Excellence Strategy EXC 2044-390685587,
+“Mathematics Münster: Dynamics–Geometry–Structure” and the National Research
+Data Infrastructure, project number&nbsp;460135501, NFDI&nbsp;29/1
+“MaRDI – Mathematical Research Data Initiative
+[Mathematische Forschungsdateninitiative]”.

openinterfaces-0.5.4/README.md

@@ -0,0 +1,69 @@
+<h1 align="center">
+<img src="https://raw.githubusercontent.com/MaRDI4NFDI/open-interfaces/refs/heads/main/assets/mardi-oif-logo.svg" width="40" style="vertical-align: text-bottom;" />
+MaRDI Open Interfaces
+</h1>
+
+[![QA](https://github.com/MaRDI4NFDI/open-interfaces/actions/workflows/qa.yaml/badge.svg)](https://github.com/MaRDI4NFDI/open-interfaces/actions/workflows/qa.yaml)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13753666.svg)](https://doi.org/10.5281/zenodo.13753666)
+
+_MaRDI Open Interfaces_ is a project aiming to improve interoperability
+in scientific computing by removing two hurdles that computational scientists
+usually face in their daily work.
+
+These hurdles are the following.
+First, numerical solvers are often implemented in different programming
+languages.
+Second, these solvers have potentially significantly diverging interfaces
+in terms of function names, order of function arguments, and the invocation
+order.
+Therefore, when a computational scientist wants to switch from one solver
+to another, it could take non-negligible effort in code modification
+and testing for the correctness.
+
+_Open Interfaces_ aim to alleviate these problems by providing automatic data
+marshalling between different languages and a set of interfaces for typical
+numerical problems such as integration of differential equations and
+optimization.
+
+This project is the part of the [_Mathematical Research Data Initiative
+(MaRDI)_](https://mardi4nfdi.de).
+
+## Data flow
+
+![Architecture of the MaRDI Open Interfaces](https://media.githubusercontent.com/media/MaRDI4NFDI/open-interfaces/refs/heads/main/assets/arch.png)
+
+This figure shows the software architecture of the _MaRDI Open Interfaces_.
+There are two principal decoupled parts. The left part is user-facing
+and allows a user to request an implementation of some numerical procedure
+and then invoke different functions in this implementation to conduct
+computations using a unified interface (Gateway)
+that hides discrepancies between different implementations.
+The other part (on the right) is completely hidden from the user
+and works with an implementation of the interface.
+Particularly, it loads the implementation and its adapter and converts
+user data to the native data for the implementation.
+
+## Installation of Python bindings and implementations
+
+The Python bindings and implementations of the interfaces are available
+from [Python Package Index (PyPI)](https://pypi.org/)
+and can be installed using
+```shell
+pip install openinterfaces
+```
+
+## Run examples
+
+Examples are provided in the `examples` directory in this repository.
+Documentation explaining some of these examples is available here:
+<https://mardi4nfdi.github.io/open-interfaces/>.
+
+
+## Funding
+
+This work is funded by the _Deutsche Forschungsgemeinschaft_ (DFG, _German
+Research Foundation_) under Germany's Excellence Strategy EXC 2044-390685587,
+“Mathematics Münster: Dynamics–Geometry–Structure” and the National Research
+Data Infrastructure, project number&nbsp;460135501, NFDI&nbsp;29/1
+“MaRDI – Mathematical Research Data Initiative
+[Mathematische Forschungsdateninitiative]”.

openinterfaces-0.5.4/common/CMakeLists.txt

@@ -0,0 +1,22 @@
+# Common components that are used by C codes: utility functions and data
+# structures.
+
+# -----------------------------------------------------------------------------
+# Library oif_common_util
+add_library(oif_common_util SHARED util.c)
+target_include_directories(oif_common_util PUBLIC ${CMAKE_SOURCE_DIR}/include)
+install(TARGETS oif_common_util DESTINATION lib)
+
+# -----------------------------------------------------------------------------
+# Library oif_common_data_structures
+get_property(cwpack_SOURCE_DIR GLOBAL PROPERTY cwpack_SOURCE_DIR)
+
+add_library(oif_common_data_structures SHARED oif_config_dict.c
+                                              ${cwpack_SOURCE_DIR}/src/cwpack.c)
+target_include_directories(oif_common_data_structures
+                           PUBLIC ${CMAKE_SOURCE_DIR}/include)
+target_include_directories(oif_common_data_structures
+                           PRIVATE ${cwpack_SOURCE_DIR}/src)
+target_link_libraries(oif_common_data_structures PRIVATE oif_common_util)
+target_link_libraries(oif_common_data_structures PRIVATE HashMap::HashMap)
+install(TARGETS oif_common_data_structures DESTINATION lib)