trame-pvui


Nametrame-pvui JSON
Version 0.1.1 PyPI version JSON
download
home_page
SummaryTrame widgets which may be used in the Paraview user interface (Pvui)
upload_time2023-05-26 22:43:24
maintainer
docs_urlNone
authorKitware
requires_python
licenseApache Software License
keywords python interactive web application framework
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Trame Paraview UI widgets
===========================================================

Trame widgets which may be used in the Paraview user interface (Pvui)

License
-----------------------------------------------------------

Apache Software License


Features
-----------------------------------------------------------

This package includes the following widgets:

 - Colormapper
 - FileBrowser
 - ServerBrowser
 - InfoPanel


Installing
-----------------------------------------------------------
Build and install the Vue components:

.. code-block:: console

    cd vue-components
    npm i
    npm run build
    cd -


Getting Started
-----------------------------------------------------------

Paraview >= 5.11 is a prerequisite to running this application.
Go to https://www.paraview.org/download/ for more information.
Once Paraview is installed, take note of its file path.

You will also need a python virtual environment
with this application and its requirements installed

.. code-block:: console

    python3.9 -m venv ~/venvs/trame
    source ~/venvs/trame/bin/activate
    pip install -e .
    deactivate


Running the example apps
-----------------------------------------------------------

To run the example paraview app, use the following

.. code-block:: console

    [path_to_paraview]/bin/pvpython example_trame_apps/paraview_app/main.py --venv ~/venvs/trame


To run the example vtk app (which hosts the colormapper widget), use the following

.. code-block:: console

    python3 example_trame_apps/vtk_app/main.py


Contributing
-----------------------------------------------------------

see `CONTRIBUTING.rst`

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "trame-pvui",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Python,Interactive,Web,Application,Framework",
    "author": "Kitware",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/71/fe/9e7af231fd7321469e4379afa9890b5c6dda5268e85deeac2e4dd87dd00a/trame-pvui-0.1.1.tar.gz",
    "platform": null,
    "description": "Trame Paraview UI widgets\n===========================================================\n\nTrame widgets which may be used in the Paraview user interface (Pvui)\n\nLicense\n-----------------------------------------------------------\n\nApache Software License\n\n\nFeatures\n-----------------------------------------------------------\n\nThis package includes the following widgets:\n\n - Colormapper\n - FileBrowser\n - ServerBrowser\n - InfoPanel\n\n\nInstalling\n-----------------------------------------------------------\nBuild and install the Vue components:\n\n.. code-block:: console\n\n    cd vue-components\n    npm i\n    npm run build\n    cd -\n\n\nGetting Started\n-----------------------------------------------------------\n\nParaview >= 5.11 is a prerequisite to running this application.\nGo to https://www.paraview.org/download/ for more information.\nOnce Paraview is installed, take note of its file path.\n\nYou will also need a python virtual environment\nwith this application and its requirements installed\n\n.. code-block:: console\n\n    python3.9 -m venv ~/venvs/trame\n    source ~/venvs/trame/bin/activate\n    pip install -e .\n    deactivate\n\n\nRunning the example apps\n-----------------------------------------------------------\n\nTo run the example paraview app, use the following\n\n.. code-block:: console\n\n    [path_to_paraview]/bin/pvpython example_trame_apps/paraview_app/main.py --venv ~/venvs/trame\n\n\nTo run the example vtk app (which hosts the colormapper widget), use the following\n\n.. code-block:: console\n\n    python3 example_trame_apps/vtk_app/main.py\n\n\nContributing\n-----------------------------------------------------------\n\nsee `CONTRIBUTING.rst`\n",
    "bugtrack_url": null,
    "license": "Apache Software License",
    "summary": "Trame widgets which may be used in the Paraview user interface (Pvui)",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [
        "python",
        "interactive",
        "web",
        "application",
        "framework"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9db4ca226b9d82186a992011067e612b34c6d84f3e0ba3f0c0f83089e4fb87fa",
                "md5": "6b73b4f120966f9be7797a9a21cd087c",
                "sha256": "4017064238341e4fedd17e4ed05af13d3c328c198c03f2858ddfbfb1a558d1fc"
            },
            "downloads": -1,
            "filename": "trame_pvui-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b73b4f120966f9be7797a9a21cd087c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 1147224,
            "upload_time": "2023-05-26T22:43:22",
            "upload_time_iso_8601": "2023-05-26T22:43:22.167516Z",
            "url": "https://files.pythonhosted.org/packages/9d/b4/ca226b9d82186a992011067e612b34c6d84f3e0ba3f0c0f83089e4fb87fa/trame_pvui-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "71fe9e7af231fd7321469e4379afa9890b5c6dda5268e85deeac2e4dd87dd00a",
                "md5": "eaadc949a54579bdb05228d2dcacb0c9",
                "sha256": "15ece0e50b986d283b4c36f02f9e01837719a0b3571559a8261d0c676d9e269d"
            },
            "downloads": -1,
            "filename": "trame-pvui-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "eaadc949a54579bdb05228d2dcacb0c9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 1132453,
            "upload_time": "2023-05-26T22:43:24",
            "upload_time_iso_8601": "2023-05-26T22:43:24.873096Z",
            "url": "https://files.pythonhosted.org/packages/71/fe/9e7af231fd7321469e4379afa9890b5c6dda5268e85deeac2e4dd87dd00a/trame-pvui-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-26 22:43:24",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "trame-pvui"
}
        
Elapsed time: 0.09471s