fips#

Tests Documentation Code Quality Code Coverage PyPI version Python Version License Ruff Pyright

Flexible Inverse Problem Solver (FIPS)

Installation#

From Source#

To install from source:

git clone https://github.com/jmineau/fips.git
cd fips
pip install -e .

Development Installation#

For development, install with the development dependencies:

git clone https://github.com/jmineau/fips.git
cd fips
python -m pip install --upgrade pip
pip install -e ".[dev,docs]"
pre-commit install

Requirements#

  • Python 3.10 or higher

Usage#

Basic Usage#

Here’s a simple example of how to use fips:

import fips

# Add usage examples here

Advanced Usage#

More advanced examples and use cases will be documented here.

API Reference#

fips

fips

Contributing#

See the CONTRIBUTING.md file for guidelines on how to contribute to this project.

Indices and tables#