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 Fake Matlab in Browser here. Please note:

  • You might need quite long time to initilaize the console for the first time. Checkout the browser console or network traffic for progress.
  • Only one line matlab expression supported, for example [1; 2; 3]*[1 2 3].
  • Only few Matlab core functions supported for now.

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.15.tar.gz (44.1 kB view details)

Uploaded Source

Built Distribution

mat2py-0.0.15-py3-none-any.whl (52.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mat2py-0.0.15.tar.gz
  • Upload date:
  • Size: 44.1 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.15.tar.gz
Algorithm Hash digest
SHA256 1ee39e1bf122b6b2582e372e3a4303d1f55f4681e01f97209e8ddd1d748f2cb9
MD5 8cb15075287f53437b039b15870ec07f
BLAKE2b-256 cb5789d6af59d45febfb1674a614e44a75e3ad14238e99c9a5393fcbeebbfa4e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mat2py-0.0.15-py3-none-any.whl
  • Upload date:
  • Size: 52.5 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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 c3d0f92339c9136bf84736730588165752e3e2d22a0acdfbdd5c4598465e06a8
MD5 b47c9035b17dc473a2c79ce41a642f17
BLAKE2b-256 741bc3a8a6b4b0e905480902af125f5db5e7e3a57ba01ceab61293a7d9e5267d

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