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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mat2py-0.0.16.tar.gz
  • Upload date:
  • Size: 44.2 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.16.tar.gz
Algorithm Hash digest
SHA256 444516f1e26b557e5d84e14d0af457968b08550e746f106ed40836aadfec2021
MD5 62d422aff1de39ac7ef2f3b63d548b16
BLAKE2b-256 2411782743e064ab360e73428ae70daf30e23b545c1daa9ffbfd8847b35085cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mat2py-0.0.16-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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 a523eafe1478ac4b435f1f9e0e10ac39fe32c83cac5502f6b69ae325584cec16
MD5 88393fe97c752a84b91c2db5444b962d
BLAKE2b-256 0d3758cbf364b440a81a248caf0e84c1848566e29ebb37a3a4a6fcde88f3b374

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