Skip to main content

mat2py mean to be drop-in replacement of Matlab by wrapping Numpy/Scipy/... packages.

Project description

mat2py

Build status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit Semantic Versions License Coverage Report

mat2py mean to be drop-in replacement of Matlab by wrapping Numpy/Scipy/... packages.

For instance usage, try the Online Matlab Emulator here. Please note:

  • Loading the environment may take quite long time, especially for the first time. Try refresh the page incase bad network connection.
  • Do not support paste chunk of matlab code yet. Please input the code line by line.
  • Do a feature request when encounter NotImplementedError.

Coverage Report

The final goal is to create a serverless, Matlab compatiable console completely in end-users' browser.

First Steps

Installation

python3 -m pip install -U mat2py

or install with Poetry

poetry add mat2py

Install the translator mh_python if needed

python3 -m pip install -U mh-python

Try the example demo_fft

# download the one already converted and formatted
wget https://raw.githubusercontent.com/mat2py/mat2py/main/tests/test_example/demo_fft.py

# or convert it yourself
echo "wget https://raw.githubusercontent.com/mat2py/miss_hit/matlab2numpy/tests/mat2np/demo_fft.m"
echo "mh_python --python-alongside --format demo_fft.m"

# run it...
python3 demo_fft.py

You can also try out the online translator by modifiy the example or put your own code.

For Developer

Initialize your code

  1. Clone mat2py:
git clone https://github.com/mat2py/mat2py 
  1. If you don't have Poetry installed run:
make poetry-download
source ~/.poetry/env
  1. Initialize poetry and install pre-commit hooks:
make install
make pre-commit-install
  1. Run the lint to check:
make lint

ToDO

  • A serverless web service for run .m/.py code inside browser
  • Complete set of MATLAB® Basic Functions
  • Copy-on-Write beheviour
  • A cleaner class hierarchy
  • Enable lint(mypy, UT, etc.)

📈 Releases

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

🛡 License

License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

📃 Citation

@misc{mat2py,
  author = {mat2py},
  title = {mat2py mean to be drop-in replacement of Matlab by wrapping Numpy/Scipy/... packages.},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/mat2py/mat2py}}
}

Credits 🚀 Your next Python package needs a bleeding-edge project structure.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mat2py-0.0.17.tar.gz (47.6 kB view details)

Uploaded Source

Built Distribution

mat2py-0.0.17-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

Details for the file mat2py-0.0.17.tar.gz.

File metadata

  • Download URL: mat2py-0.0.17.tar.gz
  • Upload date:
  • Size: 47.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for mat2py-0.0.17.tar.gz
Algorithm Hash digest
SHA256 541fab0d1e5048670b08ca923675272df88c3d071831eb11094a82a07a4b9cf8
MD5 4c8c011567aecd37a8819374043b975b
BLAKE2b-256 cbbfc31fe8f9d618107a232768aa89ff83f33fdd9bc926e28b9048e26b281a8c

See more details on using hashes here.

File details

Details for the file mat2py-0.0.17-py3-none-any.whl.

File metadata

  • Download URL: mat2py-0.0.17-py3-none-any.whl
  • Upload date:
  • Size: 57.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for mat2py-0.0.17-py3-none-any.whl
Algorithm Hash digest
SHA256 8c7e0b57624973f0ffa8226ebde7ecbae6d737a61956fcd3f47a5f3bc5c2bc0d
MD5 4d1e518f6b48867c6016216baa4282b7
BLAKE2b-256 8c7e5d7278149b187382179009f2fae9b36452e278217d6dc652dbbd5720bf10

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page