https://github.com/lbolla/EMpy

Electromagnetic Python
https://github.com/lbolla/EMpy

Last synced: about 2 months ago
JSON representation

Electromagnetic Python

• Host: GitHub
• URL: https://github.com/lbolla/EMpy
• Owner: lbolla
• License: mit
• Created: 2012-06-25T12:47:19.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-03-24T08:31:01.000Z (10 months ago)
• Last Synced: 2024-11-06T10:50:57.369Z (2 months ago)
• Language: Python
• Size: 872 KB
• Stars: 195
• Watchers: 26
• Forks: 82
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

• awesome_photonics - EMpy
• awesome-physics - EMpy - A suite of algorithms widely known and used in electromagnetic problems and optics: the transfer matrix algorithm, the rigorous coupled wave analysis algorithm and more (Electromagnetism / Sound)

README

        
EMpy - ElectroMagnetic Python

*****************************

.. image:: https://github.com/lbolla/EMpy/actions/workflows/python-app.yml/badge.svg

    :target: https://github.com/lbolla/EMpy/actions/workflows/python-app.yml

.. image:: https://badge.fury.io/py/ElectroMagneticPython.svg

    :target: https://badge.fury.io/py/ElectroMagneticPython

`EMpy - ElectroMagnetic Python` is a suite of algorithms widely known

and used in electromagnetic problems and optics: the transfer matrix

algorithm, the rigorous coupled wave analysis algorithm and more.

Run the examples in `examples/*` to have an idea how EMpy works.

Visit http://lbolla.github.io/EMpy/ for more information.

Installation

============

.. code-block:: bash

  $> pip install ElectromagneticPython

Optionally, install `bvp`:

.. code-block:: bash

  $> pip install scikits.bvp1lg

Development

===========

First, download the source code from https://github.com/lbolla/EMpy. Then, from inside a `virtualenv`, install with:

.. code-block:: bash

    $> pip install -r requirements_dev.txt

    $> python setup.py develop

Run tests with:

.. code-block:: bash

    $> python setup.py test

Release process

===============

1. Edit CHANGES

2. `bumpversion major|minor|patch`

3. `git push && git push --tags`

Citation

========

If you find EMpy useful in your job, please consider adding a citation.

As reference:

.. code-block::

   Bolla, L. (2017). EMpy [Computer software]. https://github.com/lbolla/EMpy/

As text:

.. code-block::

   We used EMpy (version x.y.z) to complete our work.