Metadata-Version: 2.1
Name: materialx_gpuopen_app
Version: 1.39.5
Summary: A Flask-based application for accessing GPUOpen MaterialX materials.
Author-email: Bernard Kwok <kwokcb@gmail.com>
Project-URL: Homepage, https://kwokcb.github.io/materialxWeb/
Project-URL: Issues, https://github.com/kwokcb/materialxWeb/issues
Project-URL: Source Code, https://github.com/kwokcb/materialxWeb
Project-URL: Documentation, https://kwokcb.github.io/materialxWeb/
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown

## Python GPUOpen Material Inspector 

This sample package shows the basic components required to connect MaterialX running in Python to a Web client running Javascript in order to access materials on the <a href="https://matlib.gpuopen.com/main/materials/all">AMD GPUOpen material site</a>.

<img src="https://raw.githubusercontent.com/kwokcb/materialxWeb/refs/heads/main/flask/gpuopen/images/GPUOpen_Flask.png" alt="Sample extracted material" width="100%">

### Dependents
- Usage of the `materialxMaterials` Python package
- `flask` and `flask-socketio` Python packages
- `socket-io` Javascript library

### Installation

Either install the package from `PyPi`:

```
pip install materialx_gpuopen_app
```

or clone the <a href="https://github.com/kwokcb/materialxWeb">materialXWeb</a>  
repository and install from the root folder:

```
pip install .
```

or 

```
pip install -e .
```
if planning to perform edits on the repository.

### Execution

Run the main package using:
```
materialx-gpuopen-app
```
or directly with Python:
```
python MaterialXGPUOpenApp.py
```

By default the application is running a local server. To access the client page open the following in a Web browser:
```
http://127.0.0.1:8080
```



