Welcome to npsolve’s documentation!

The npsolve package lets you use object-oriented classes and methods for calculations with numerical solvers.

Instead of defining equations, you can write methods with any combination of logic and equations. It decouples the calculations from the machinery to numerically iterate with them, giving you all the benefits you’d expect from objects.

Many numerical solvers (like those in scipy) provide candidate solutions as a numpy ndarray. They often also require a numpy ndarray as a return value (e.g. an array of derivatives) during the solution. These requirements can make it difficult to use an object oriented approach to performing the calculations. Usually, we end up with script-like code that looses many of the benefits of object-oriented programming.

The npsolve framework links a solver with multiple classes that handle the calculations for each step in the algorithm. It allows different parts of the calculations to be encapsulated and polymorphic, and makes the code much easier to modify and maintain.

Contents:

• Tutorials
  • Tutorial 1 - Basics
  • Tutorial 2 - Handling discontinuities
  • Tutorial 3 - Timeseries input
  • Tutorial 4 - Sharing values between objects
  • Tutorial 5 - Using polymorphism
  • Tutorial 6 - Logging variables and stopping
• Package documentation
  • npsolve package
  • npsolve.core module
  • npsolve.cache module
  • npsolve.soft_functions module
  • npsolve.solvers module
  • npsolve.utils module
• Related packages

Indices and tables

• Index
• Module Index
• Search Page