Initial commit

Author: Lucas Garcia

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+>_If you believe you have discovered a security vulnerability, please **do not** open an issue or make a pull request.  Follow the instructions in the [SECURITY.MD](SECURITY.MD) file in this repository._
+
+Thank you for your interest in contributing to a MathWorks repository!  We encourage contributions large and small to this repository.  
+
+**Contributions do not have to be code!** If you see a way to explain things more clearly or a great example of how to use something, please contribute it (or a link to your content).  We welcome issues even if you don't code the solution.  We also welcome pull requests to resolve issues that we haven't gotten to yet!
+
+## How to contribute
+
+* **Open an issue:** Start by [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) in the repository that you're interested in.  That will start a conversation with the maintainer.  When you are creating a bug report, please include as many details as possible.  Please remember that other people do not have your background or understanding of the issue; make sure you are clear and complete in your description.
+* **Work in your own public fork:** If you choose to make a contribution, you should [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).  This creates an editable copy on GitHub where you can write, test, and refine your changes.  We suggest that you keep your changes small and focused on the issue you submitted.
+* **Sign a Contributor License Agreement (CLA):** We require that all outside contributors sign a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) before we can accept your contribution.  When you create a pull request (see below), we'll reach out to you if you do not already have one on file.  Essentially, the CLA gives us permission to publish your contribution as part of the repository.
+* **Make a pull request:** "[Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" is a confusing term, but it means exactly what it says:  You're requesting that the maintainers of the repository pull your changes in.  If you don't have a CLA on file, we'll reach out to you.  Your contribution will be reviewed, and we may ask you to revise your pull request based on our feedback.  Once everyone is satisfied, we'll merge your pull request into the repository.
+
+## Guidelines
+
+We don't have best practices for writing MATLAB code, but we do have some recommendations:
+
+* You should not have any warnings or errors in the [code analyzer report](http://www.mathworks.com/help/matlab/matlab_prog/matlab-code-analyzer-report.html)
+* [Loren Shure's blog](https://blogs.mathworks.com/loren) has [great advice on improving your MATLAB code](https://blogs.mathworks.com/loren/category/best-practice/)
+* Examples should be written as [live scripts](https://www.mathworks.com/help/matlab/matlab_prog/what-is-a-live-script-or-function.html) and then [exported as HTML](https://www.mathworks.com/help/matlab/matlab_prog/share-live-scripts.html).
+* We adhere to the [CommonMark](https://commonmark.org/) specification where it does not conflict with GitHub rendering.  If you edit your Markdown in Visual Studio Code or a similar editor, it uses [markdownlint](https://github.com/DavidAnson/markdownlint) to highlight issues in your Markdown.
+
+**Again, thanks for contributing, and we look forward to your issues and pull requests!**

LICENSE.txt

@@ -0,0 +1,6 @@
+Copyright (c) 2022, The MathWorks, Inc.
+All rights reserved.
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,97 @@
+# MATLAB Live Task for Python
+
+The MATLAB® Live Task for Python® enables you to write and execute Python code directly inside of a MATLAB Live Script. Since R2022a, MATLAB provides a way to develop your own [custom live task](https://www.mathworks.com/help/matlab/creating_guis/live-task-development-overview.html).
+
+---
+
+## Requirements
+### Required MathWorks Products
+* MATLAB R2022a or later
+
+### Required 3rd Party Products
+* Python (supported Python versions by MATLAB release can be found [here](https://www.mathworks.com/content/dam/mathworks/mathworks-dot-com/support/sysreq/files/python-compatibility.pdf))
+
+---
+
+## Install
+Run the `install` script to add the required paths to your MATLAB environment and configure the MATLAB Live Task for Python. Click 'Ok' when promtped with the following UI to configure the Live Editor task metadata:
+
+![img/pythonTaskInstall.png](img/pythonTaskInstall.png)
+
+---
+
+## Getting Started
+To insert the live task in your live script:
+
+1. Go to the Live Editor tab in the Editor Toolstrip and select Task: 
+
+    ![img/pythonTask1.png](img/pythonTask1.png)
+
+2. Then, choose the live task under the MY TASKS category:
+
+    ![img/pythonTask2.png](img/pythonTask2.png)
+
+Alternatively you may simply type `python` and the autocomplete feature will suggest the appropriate task:
+
+![img/pythonTask3.png](img/pythonTask3.png)
+
+This is what the MATLAB Live Task for Python looks like:
+
+![img/pythonTask4.png](img/pythonTask4.png)
+
+First, create a variable in the MATLAB workspace: 
+```
+>> T = 'We at MathWorks believe in the importance of engineers and scientists. They increase human knowledge and profoundly improve our standard of living.';
+```
+
+The Python input and output variables can be mapped with variables in the MATLAB workspace: 
+
+![img/pythonTask5.png](img/pythonTask5.png)
+
+You can choose to write either Python statements or a Python script file: 
+
+![img/pythonTask6.png](img/pythonTask6.png)
+
+and retrieve the required variables to be used back in MATLAB:
+
+![img/pythonTask7.png](img/pythonTask7.png)
+
+The equivalent MATLAB code to run either the Python statements (using [`pyrun`](pyrun)) or a Python script (using [`pyrunfile`](https://www.mathworks.com/help/matlab/ref/pyrunfile.html)) is generated and run automatically by default like any live task:
+
+![img/pythonTask8.png](img/pythonTask8.png)
+
+```
+>> wrapped = string(wrapped)'
+
+wrapped = 
+
+  6×1 string array
+
+    "% We at MathWorks believe in"
+    "% the importance of engineers"
+    "% and scientists. They"
+    "% increase human knowledge and"
+    "% profoundly improve our"
+    "% standard of living."
+```
+
+---
+
+## Examples
+
+You can find examples on how to use the MATLAB Live Task for Python in the `examples` folder within this repository.
+
+---
+
+## Support
+
+Technical issues or enhancement requests can be submitted [here](https://github.com/mathworks/MATLAB-Live-Task-for-Python/issues).
+
+---
+
+## License
+The license is available in the License file within this repository
+
+Copyright © 2022 MathWorks, Inc. All rights reserved.
+
+"Python" and the Python logos are trademarks or registered trademarks of the Python Software Foundation, used by MathWorks with permission from the Foundation.

SECURITY.md

@@ -0,0 +1,6 @@
+# Reporting Security Vulnerabilities 
+
+If you believe you have discovered a security vulnerability, please report it to 
+[[email protected]](mailto:[email protected]). Please see 
+[MathWorks Vulnerability Disclosure Policy for Security Researchers](https://www.mathworks.com/company/aboutus/policies_statements/vulnerability-disclosure-policy.html) 
+for additional information.  

examples/DictionaryComprehension.mlx

@@ -0,0 +1,13 @@
+# Data conversion
+import numpy as np
+data = np.array(data)
+
+# Using Scikit-learn
+from sklearn.cluster import KMeans as scikit_kmeans
+kmeans_scikit_res = scikit_kmeans(n_clusters=nclust,init='k-means++').fit(data)
+scikit_centroids = kmeans_scikit_res.cluster_centers_
+
+# Using Scipy
+import scipy.cluster
+scipy_res = scipy.cluster.vq.kmeans2(data,k=nclust,minit='++')
+scipy_centroids = scipy_res[0]

examples/GettingStarted.mlx

@@ -0,0 +1,5 @@
+% Copyright 2022 The MathWorks, Inc.
+
+addpath(genpath("src"),"-end")
+savepath
+matlab.task.configureMetadata(fullfile("src","RunPythonTask.m"))