solve-nivp 0.2.0.dev1__tar.gz → 0.2.0.dev3__tar.gz

solve_nivp-0.2.0.dev3/MANIFEST.in

@@ -0,0 +1,10 @@
+include LICENSE
+include README.md
+include pyproject.toml
+include pytest.ini
+include docs/Makefile
+include docs/make.bat
+
+recursive-include src/solve_nivp *.py
+recursive-include tests *.py
+recursive-include docs/source *.py *.rst

{solve_nivp-0.2.0.dev1/solve_nivp.egg-info → solve_nivp-0.2.0.dev3}/PKG-INFO

@@ -1,16 +1,15 @@
 Metadata-Version: 2.4
 Name: solve_nivp
-Version: 0.2.0.dev1
+Version: 0.2.0.dev3
 Summary: A Python toolkit for integrating nonsmooth dynamical systems
 Author: David Riley, Ioannis Stefanou
-License: MIT
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/ERC-INJECT/solve_nivp
 Project-URL: Documentation, https://github.com/ERC-INJECT/solve_nivp/tree/main/docs
 Project-URL: Issues, https://github.com/ERC-INJECT/solve_nivp/issues
 Keywords: nonsmooth dynamics,ODE,DAE,variational inequalities,semismooth Newton,projection methods
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Classifier: Topic :: Scientific/Engineering :: Physics

solve_nivp-0.2.0.dev3/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

solve_nivp-0.2.0.dev3/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.ODESolver.rst

@@ -0,0 +1,23 @@
+solve\_nivp.ODESolver
+=====================
+
+.. currentmodule:: solve_nivp
+
+.. autoclass:: ODESolver
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~ODESolver.__init__
+      ~ODESolver.solve
+   
+   
+
+   
+   
+   

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.ODESystem.rst

@@ -0,0 +1,25 @@
+solve\_nivp.ODESystem
+=====================
+
+.. currentmodule:: solve_nivp
+
+.. autoclass:: ODESystem
+
+   
+   .. automethod:: __init__
+
+   
+   .. rubric:: Methods
+
+   .. autosummary::
+   
+      ~ODESystem.__init__
+      ~ODESystem.step
+      ~ODESystem.step_adaptive
+      ~ODESystem.step_fixed
+   
+   
+
+   
+   
+   

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.adaptive_integrator.rst

@@ -0,0 +1,12 @@
+solve\_nivp.adaptive\_integrator
+================================
+
+.. automodule:: solve_nivp.adaptive_integrator
+
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AdaptiveStepping
+   

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.alart_curnier_contact.rst

@@ -0,0 +1,12 @@
+solve\_nivp.alart\_curnier\_contact
+===================================
+
+.. automodule:: solve_nivp.alart_curnier_contact
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_alart_curnier_contact
+      build_dynamic_alart_curnier_contact

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.block_system.rst

@@ -0,0 +1,7 @@
+solve\_nivp.block\_system
+=========================
+
+.. automodule:: solve_nivp.block_system
+
+Compatibility module. New code should prefer
+``solve_nivp.solvers.block_system``.

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.contact.rst

@@ -0,0 +1,17 @@
+solve\_nivp.contact
+===================
+
+.. automodule:: solve_nivp.contact
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_impulse_contact
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ContactSystem

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.desaxce_contact.rst

@@ -0,0 +1,13 @@
+solve\_nivp.desaxce\_contact
+============================
+
+.. automodule:: solve_nivp.desaxce_contact
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_dynamic_desaxce_contact
+      build_dynamic_desaxce_projected_contact
+      build_dynamic_desaxce_residual_contact

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.integrations.rst

@@ -0,0 +1,22 @@
+solve\_nivp.integrations
+========================
+
+.. automodule:: solve_nivp.integrations
+
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AlgebraicBackwardEuler
+      BackwardEuler
+      BackwardEulerSchur
+      CompositeMethod
+      EmbeddedBETR
+      IntegrationMethod
+      RadauIIA
+      RadauIIASchur
+      SDIRK2
+      ThetaMethod
+      Trapezoidal
+   

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.macklin_contact.rst

@@ -0,0 +1,17 @@
+solve\_nivp.macklin\_contact
+============================
+
+.. automodule:: solve_nivp.macklin_contact
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_macklin_contact_blocked
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MacklinBlockSystem

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.moreau_jean_fremond.rst

@@ -0,0 +1,17 @@
+solve\_nivp.moreau\_jean\_fremond
+=================================
+
+.. automodule:: solve_nivp.moreau_jean_fremond
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_moreau_jean_fremond
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      MoreauJeanFremondStepper

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.ncp_contact.rst

@@ -0,0 +1,19 @@
+solve\_nivp.ncp\_contact
+========================
+
+.. automodule:: solve_nivp.ncp_contact
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_dynamic_ncp_contact
+      build_ncp_contact
+      build_ncp_contact_blocked
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      NCPBlockSystem

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.nonlinear_solvers.rst

@@ -0,0 +1,8 @@
+solve\_nivp.nonlinear\_solvers
+==============================
+
+.. automodule:: solve_nivp.nonlinear_solvers
+
+Compatibility module. New code should prefer
+``solve_nivp.solvers.nonlinear_solvers``.
+   

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.pcr.rst

@@ -0,0 +1,6 @@
+solve\_nivp.pcr
+===============
+
+.. automodule:: solve_nivp.pcr
+
+Compatibility module. New code should prefer ``solve_nivp.solvers.pcr``.

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.projected_radau_contact.rst

@@ -0,0 +1,21 @@
+solve\_nivp.projected\_radau\_contact
+=====================================
+
+.. automodule:: solve_nivp.projected_radau_contact
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_projected_radau_contact
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      DeSaxceProjectedConeLaw
+      NCPNormalConeLaw
+      ProjectedRadauContactLaw
+      ProjectedRadauContactModel
+      SOCFischerBurmeisterLaw

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.projections.rst

@@ -0,0 +1,21 @@
+solve\_nivp.projections
+=======================
+
+.. automodule:: solve_nivp.projections
+
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+   
+      AlgebraicConstraintProjection
+      AnisotropicSOCProjection
+      CompositeContactProjection
+      CoulombProjection
+      GeneralMoreauVIProjection
+      IdentityProjection
+      MoreauSOCProjection
+      MuScaledSOCProjection
+      Projection
+      SignProjection
+   

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.rattle_contact.rst

@@ -0,0 +1,25 @@
+solve\_nivp.rattle\_contact
+===========================
+
+.. automodule:: solve_nivp.rattle_contact
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      build_dynamic_rattle_contact
+      build_rattle_system
+      solve_dynamic_rattle_contact
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      RattleAlgebraicSpec
+      RattleBilateralSpec
+      RattleContactSpec
+      RattleContactSystem
+      RattleMechanicalSystem
+      RattleSolveResult
+      RattleSolver

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.rl.callbacks.rst

@@ -0,0 +1,7 @@
+solve\_nivp.rl.callbacks
+=========================
+
+.. automodule:: solve_nivp.rl.callbacks
+   :members:
+   :undoc-members:
+   :show-inheritance:

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.rl.dependency.rst

@@ -0,0 +1,12 @@
+solve\_nivp.rl.dependency
+=========================
+
+.. automodule:: solve_nivp.rl.dependency
+
+   
+   .. rubric:: Functions
+
+   .. autosummary::
+   
+      ensure_rl_dependencies
+   

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.rl.env.rst

@@ -0,0 +1,7 @@
+solve\_nivp.rl.env
+==================
+
+.. automodule:: solve_nivp.rl.env
+   :members:
+   :undoc-members:
+   :show-inheritance:

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.rl.rst

@@ -0,0 +1,16 @@
+solve\_nivp.rl
+==============
+
+.. automodule:: solve_nivp.rl
+
+The environment and callback modules require optional reinforcement-learning
+dependencies. Install ``solve_nivp[rl]`` to use them at runtime.
+
+.. rubric:: Modules
+
+.. toctree::
+   :maxdepth: 1
+
+   solve_nivp.rl.callbacks
+   solve_nivp.rl.dependency
+   solve_nivp.rl.env

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.rst

@@ -0,0 +1,38 @@
+solve\_nivp API
+===============
+
+.. automodule:: solve_nivp
+   :no-members:
+
+Top-Level Functions
+-------------------
+
+.. autofunction:: solve_nivp.solve_nivp
+
+``solve_ivp_ns`` is kept as a compatibility alias for ``solve_nivp``.
+
+Modules
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+   solve_nivp.ODESolver
+   solve_nivp.ODESystem
+   solve_nivp.adaptive_integrator
+   solve_nivp.alart_curnier_contact
+   solve_nivp.block_system
+   solve_nivp.contact
+   solve_nivp.desaxce_contact
+   solve_nivp.integrations
+   solve_nivp.macklin_contact
+   solve_nivp.moreau_jean_fremond
+   solve_nivp.ncp_contact
+   solve_nivp.nonlinear_solvers
+   solve_nivp.pcr
+   solve_nivp.projected_radau_contact
+   solve_nivp.projections
+   solve_nivp.rattle_contact
+   solve_nivp.rl
+   solve_nivp.solvers
+   solve_nivp.soccp_pgs

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.soccp_pgs.rst

@@ -0,0 +1,19 @@
+solve\_nivp.soccp\_pgs
+======================
+
+.. automodule:: solve_nivp.soccp_pgs
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      desaxce_shift_factory
+      fremond_shift_factory
+      soccp_pgs
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      SocppPgsInfo

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.solvers.block_system.rst

@@ -0,0 +1,11 @@
+solve\_nivp.solvers.block\_system
+=================================
+
+.. automodule:: solve_nivp.solvers.block_system
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      BlockStructuredSystem
+      SchurComplementSolver

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.solvers.nonlinear_solvers.rst

@@ -0,0 +1,10 @@
+solve\_nivp.solvers.nonlinear\_solvers
+======================================
+
+.. automodule:: solve_nivp.solvers.nonlinear_solvers
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      ImplicitEquationSolver

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.solvers.pcr.rst

@@ -0,0 +1,10 @@
+solve\_nivp.solvers.pcr
+=======================
+
+.. automodule:: solve_nivp.solvers.pcr
+
+   .. rubric:: Functions
+
+   .. autosummary::
+
+      pcr_solve

solve_nivp-0.2.0.dev3/docs/source/api/solve_nivp.solvers.rst

@@ -0,0 +1,13 @@
+solve\_nivp.solvers
+===================
+
+.. automodule:: solve_nivp.solvers
+
+.. rubric:: Modules
+
+.. toctree::
+   :maxdepth: 1
+
+   solve_nivp.solvers.block_system
+   solve_nivp.solvers.nonlinear_solvers
+   solve_nivp.solvers.pcr

solve_nivp-0.2.0.dev3/docs/source/conf.py

@@ -0,0 +1,70 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+from pathlib import Path
+import sys
+
+sys.path.insert(0, str(Path(__file__).resolve().parents[2] / 'src'))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'solve_nivp'
+copyright = '2025, David Riley'
+author = 'David Riley'
+release = '0.2.0.dev1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',  # NumPy/Google-style docstrings
+    'sphinx.ext.viewcode',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.intersphinx',
+]
+
+# API stubs are committed under docs/source/api. Regenerate them explicitly
+# when the public module list changes so normal docs builds do not dirty Git.
+autosummary_generate = False
+
+# Type hints in description for cleaner signatures
+autodoc_typehints = 'description'
+
+# Optional extras are documented without requiring their runtime dependencies.
+autodoc_mock_imports = [
+    'gymnasium',
+    'stable_baselines3',
+    'sb3_contrib',
+]
+
+# Napoleon options
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+
+# Intersphinx mappings for cross-references
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'scipy': ('https://docs.scipy.org/doc/scipy/', None),
+}
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = []
+
+latex_engine = 'xelatex'
+# latex_elements = {
+#     'preamble': r'\usepackage[utf8]{inputenc}\usepackage[T1]{fontenc}',
+# }

solve_nivp-0.2.0.dev3/docs/source/development.rst

@@ -0,0 +1,30 @@
+Development
+===========
+
+Testing
+-------
+Run the unit tests from the project root in a fresh virtual environment:
+
+.. code-block:: bash
+
+   python3 -m venv .venv && source .venv/bin/activate
+   pip install -U pip
+   pip install -e .[test]
+   pytest -q
+
+Documentation
+-------------
+Build the docs locally:
+
+.. code-block:: bash
+
+   cd docs
+   make clean html
+
+Then open ``_build/html/index.html`` in your browser.
+
+Style and contributions
+-----------------------
+- Use NumPy-style docstrings (processed by ``napoleon``).
+- Keep public APIs documented and covered by tests.
+- Submit PRs with focused changes and include updates to docs/examples.