Skip to main content

eispy2d

An Open-Source Python Library for the development of algorithms for 2D Electromagnetic Inverse Scattering Problems (EISPs).

Motivation

This library was thought to provide a common and basic framework for researchers that want to test new ideas about algorithms for EISPs. Then, they will not need to develop the whole structure (domain model, discretization formulations, forward solvers, data visualization, statistical inference, etc).

What can I do with this library?

With the tools in this library, you can represent an instance of EISP, develop algorithms, run them, and analyze the results in many different ways. The library provides specific implementations for case studies and benchmarking, so one can get preliminary results, measure the performance, and compare with different algorithms or different versions of the same algorithm.

Model assumptions

Besides considering the two-dimensional formulation, we are assuming as well TMz polarization of incident waves and linear, isotropic, non-dispersive, and non-magnetic materials.

Install

Initially, the library was thought to be a collection of ".py" files that anyone can download and add to his/her project. It would be amazing if, one day, this library became a well-organized Python package which one can install through Pip or Conda. But, as this is an implementation developed by only one person, then these steps will be considered someday in the future. For while, you just need to download the codes and call the modules as you do with any library that you create.

Dependencies

Before using eispy2d, please ensure you have all the required dependencies installed. The project includes a requirements.txt file listing all necessary packages. You can install these dependencies by running pip install -r requirements.txt in your command line or terminal. These packages are essential for the proper functioning of the library, including numerical computations, visualization tools, and optimization algorithms that power the electromagnetic inverse scattering solvers.

How to use

You may find usages examples here. There are scripts and Jupyter Notebooks in which you can see how the classes are called, how to build a problem, how to run an experiment, etc.

Documentation

Documentation is currently being built and a previous version can be found in https://eispy2d-docs.readthedocs.io/en/latest/api.html

Contribute

You are totally welcome to contribute to this library by finding bugs, suggesting changes, implementing the algorithms in the literature, and providing your algorithms so others can use them to compare in their experiments. You may add issues, send pull requests or contact me through e-mail.

Citation

We've already written an article describing the library. While it is still under review, its preprint version is available at the arXiv repository via this link. If you use this library, you may acknowledge by citing it:

@ARTICLE{11015426,
  author={Costa Batista, André and Adriano, Ricardo and Batista, Lucas S.},
  journal={IEEE Access}, 
  title={EISPY2D: An Open-Source Python Library for the Development and Comparison of Algorithms in Two-Dimensional Electromagnetic Inverse Scattering Problems}, 
  year={2025},
  volume={13},
  number={},
  pages={92134-92154},
  keywords={Libraries;Electromagnetic scattering;Imaging;Image reconstruction;Electromagnetics;Microwave theory and techniques;Microwave integrated circuits;Microwave imaging;Microwave FET integrated circuits;Inverse problems;Comparison of algorithms;electromagnetic inverse scattering problem;microwave imaging;open-source library;optimization},
  doi={10.1109/ACCESS.2025.3573679}
}

Further information

For further information and questions, please send me an email.

Have fun! André

Metadata

Release files for eispy2d 1.0.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for eispy2d 1.0.18
File Size Uploaded Provenance Actions
eispy2d-1.0.18.tar.gz 230.9 kB Without provenance Details for eispy2d-1.0.18.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for eispy2d 1.0.18
File Interpreter ABI Platform Actions
eispy2d-1.0.18-py3-none-any.whl Python 3 none any Details for eispy2d-1.0.18-py3-none-any.whl

Total release size: 499.8 kB

Release files / eispy2d-1.0.18.tar.gz

Download URL eispy2d-1.0.18.tar.gz
Size 230.9 kB
Tags Source
SHA-256 checksum
How to use checksums
9670da87dbbafca8a295108a18280aed4992e403e793c8ba2f99f0f8a5e37b0b
BLAKE2b-256 checksum
How to use checksums
272527c57c6c2d29520cd03e239396293d45b1b8543f0d08aef21441a3e3a539
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / eispy2d-1.0.18-py3-none-any.whl

Download URL eispy2d-1.0.18-py3-none-any.whl
Size 268.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bc12787ae3216b8d818cf3ca80012a5dedcf5a6e06dc62e25455c266ac25b62d
BLAKE2b-256 checksum
How to use checksums
744f6701f7b4473c6970024bbffed1dcc3fe4ae2cb14a29bf0dc40f08235ab8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for eispy2d 1.0.18

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page