Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 3.52 KB

README.rst

File metadata and controls

104 lines (73 loc) · 3.52 KB

PyVistaQt

PyPI conda-forge Azure Pipelines GitHub Actions MIT License Codecov isort pylint mypy black

pyvistaqt is a helper module for pyvista to enable you to plot using Qt by placing a vtk-widget into a background renderer. This can be quite useful when you desire to update your plot in real-time.

Documentation

For the installation and usage of this package, please visit the PyVistaQt documentation.

Refer to the PyVista documentation for detailed installation and usage details of the core package which is used alongside this package.

For general questions about the project, its applications, or about software usage, please create a discussion in pyvista/discussions where the community can collectively address your questions. You are also welcome to join us on Slack or send one of the developers an email. The project support team can be reached at [email protected].

Installation

Installation using pip is:

$ pip install pyvistaqt

To install this package with conda run:

$ conda install -c conda-forge pyvistaqt

You can also visit PyPI or GitHub to download the source.

Once installed, use the pyvistaqt.BackgroundPlotter like any PyVista plotter.

Contributing

We absolutely welcome contributions. pyvistaqt is maintained on a volunteer basis and thus we need to foster a community that can support user questions and develop new features to make this software a useful tool for all users while encouraging every member of the community to share their ideas. To learn more about contributing to PyVista, please see the pyvista Contributing Guide and Code of Conduct.