Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sparse matrix solvers from SciPy #182

Merged
merged 4 commits into from
Jun 24, 2024
Merged

Sparse matrix solvers from SciPy #182

merged 4 commits into from
Jun 24, 2024

Conversation

jwhhh
Copy link
Member

@jwhhh jwhhh commented Jun 21, 2024

CoFI Pull Request Template

Description

This pull request links CoFI to all the sparse matrix solvers provided by SciPy.

Type of Change

Please indicate the type of change this pull request represents:

  • New inference tool
  • CoFI core / utils
  • Documentation
  • Others (please specify here)

Checklist for new inference tool

  • Run the helper script tools/new_inference_tool.py to generate a new tool file
  • Implement __init__ and __call__ methods
  • Define class variables required_in_problems, optional_in_problem, required_in_options, and optional_in_options for input validation
  • Define class variables short_description and documentation_links for displaying tool related information
  • Import and add the tool subclass name to src/cofi/tools/__init__.py
  • Add tool name and class reference to the inference_tools_table in file src/cofi/tools/__init__.py
  • Fill in the last few lines of the tool file so that your new tool is registered in the inference tools tree
  • Write tests for your new inference tool under tests/cofi_tools
  • Format the code with black using the default project setting (in pyproject.toml)
  • Prepare a relevant example under CoFI examples and raise a pull request in the cofi-examples repository
    https://github.com/inlab-geo/cofi-examples

If unsure, refer to the detailed instructions here: https://cofi.readthedocs.io/en/latest/developer/new_tool.html.

Checklist for CoFI core / utils

  • Update tests to cover the new functionalities
  • Update the documentation that reflects the change
  • Format the code with black using the default project setting (in pyproject.toml)

If unsure, refer to the detailed instructions here: https://cofi.readthedocs.io/en/latest/developer/cofi_core.html

@jwhhh jwhhh linked an issue Jun 24, 2024 that may be closed by this pull request
@jwhhh jwhhh marked this pull request as ready for review June 24, 2024 00:04
@jwhhh jwhhh merged commit 38f8624 into main Jun 24, 2024
5 checks passed
@jwhhh jwhhh deleted the feature/sparsesolver branch June 25, 2024 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Link to scipy.sparse.linalg.minres
1 participant