PyMODAlib 0.1.7b1

Library providing Python implementations of MODA's algorithms.

PyMODAlib

PyMODAlib is a Python library containing the algorithms used by PyMODA. With PyMODAlib, you can write Python scripts to perform the same calculations as PyMODA.

Some of PyMODAlib's algorithms are MATLAB-packaged libraries, while some are Python translations of algorithms belonging to MODA.

Installing PyMODAlib

PyMODAlib can be installed using pip. Open a terminal and run:

pip install pymodalib

Tip: on macOS/Linux, replace pip with the correct command for your system (e.g. pip3).

Updating PyMODAlib

PyMODAlib is likely to be updated regularly. To update your installed version, open a terminal and run:

pip install -U pymodalib

Current status

PyMODAlib is still early in development. Currently, the features implemented are:

• Detecting harmonics.

Examples

There are examples of using PyMODAlib's functionality in the examples directory.

License

You may use, distribute and modify this software under the terms of the GNU General Public License v3.0. See LICENSE.

Developer notes

Developing PyMODAlib

When developing PyMODAlib, you can test your changes by installing the library locally in "editable" mode. From the root of the repository, run:

pip install -e .

Tip: After making changes to PyMODAlib, you don't need to run the pip install command again.

Switching back to the release version of PyMODAlib is simple:

pip uninstall pymodalib -y
pip install pymodalib

Packaging the project

From the documentation:

rm -r dist/
python setup.py sdist
python setup.py bdist_wheel
twine upload dist/*