Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[New Port Request] ParaView #9180

Closed
Neumann-A opened this issue Dec 2, 2019 · 2 comments · Fixed by #9960
Closed

[New Port Request] ParaView #9180

Neumann-A opened this issue Dec 2, 2019 · 2 comments · Fixed by #9960
Labels
category:new-port The issue is requesting a new library to be added; consider making a PR! info:good-first-issue This issue would be a good issue to get one's feet wet in solving.

Comments

@Neumann-A
Copy link
Contributor

Library name: ParaView

Library description: VTK-based Data Analysis and Visualization Application

Source repository URL: https://github.com/Kitware/ParaView

Project homepage (if different from the source repository): https://www.paraview.org/

Anything else that is useful to know when adding (such as optional features the library may have that should be included):

https://github.com/Kitware/ParaView/blob/master/Documentation/dev/build.md

Some features might be necessary:

Build Settings
ParaView has a number of settings available for its build. The common variables to modify include:

PARAVIEW_BUILD_SHARED_LIBS (default ON): If set, shared libraries will be built. This is usually what is wanted.
PARAVIEW_BUILD_QT_GUI (default ON): Builds the paraview GUI application.
PARAVIEW_USE_MPI (default OFF): Whether MPI support will be available or not.
PARAVIEW_USE_OSPRAY (default OFF): Whether OSPRay ray-tracing support will be available or not.
PARAVIEW_ENABLE_PYTHON (default OFF): Whether Python support will be available or not.
PARAVIEW_ENABLE_WEB (default OFF; requires PARAVIEW_ENABLE_PYTHON): Whether ParaViewWeb support will be available or not.
PARAVIEW_PLUGIN_ENABLE_<name> (default varies): Whether to enable a plugin or not.
ParaView uses VTK's module system to control its build. This infrastructure provides a number of variables to control modules which are not otherwise controlled by the other options provided.

VTK_MODULE_USE_EXTERNAL_<name> (default depends on PARAVIEW_USE_EXTERNAL): Use an external source for the named third-party module rather than the copy contained within the ParaView source tree.
VTK_MODULE_ENABLE_<name> (default DEFAULT): Change the build settings for the named module. Valid values are those for the module system's build settings (see below).
VTK_GROUP_ENABLE_<name> (default DEFAULT): Change the default build settings for modules belonging to the named group. Valid values are those for the module system's build settings (see below).
For variables which use the module system's build settings, the valid values are as follows:

YES: Require the module to be built.
WANT: Build the module if possible.
DEFAULT: Use the settings by the module's groups and PARAVIEW_BUILD_ALL_MODULES.
DONT_WANT: Don't build the module unless required as a dependency.
NO: Do not build the module.
If any YES module requires a NO module, an error is raised.

Less common, but variables which may be of interest to some:

PARAVIEW_BUILD_DEVELOPER_DOCUMENTATION (default OFF): If set, the HTML documentation for ParaView's C++, Python, and proxies will be generated.
PARAVIEW_ENABLE_EXAMPLES (default OFF): If set, ParaView's example code will be added as tests to the ParaView test suite.
PARAVIEW_ENABLE_LOGGING (default ON): If set, enhanced logging will be enabled.
PARAVIEW_USE_VTKM (default ON): Enable VTK-m accelerated algorithms in ParaView.
PARAVIEW_ENABLE_VISITBRIDGE (default OFF): Enable support for VisIt readers.
PARAVIEW_BUILD_TESTING (default OFF): Whether to build tests or not. Valid values are OFF (no testing), WANT (enable tests as possible), and ON (enable all tests; may error out if features otherwise disabled are required by test code).
PARAVIEW_ENABLE_KITS (default OFF; requires CMake 3.12+): Compile ParaView into a smaller set of libraries. Can be useful on platforms where ParaView takes a long time to launch due to expensive disk access.
PARAVIEW_ENABLE_CATALYST (default ON): Whether to build Catalyst CoProcessing support or not.
More advanced options:

PARAVIEW_BUILD_ALL_MODULES (default OFF): If set, ParaView will enable all modules not disabled by other features.
PARAVIEW_ENABLE_NVPIPE (default OFF): Use nvpipe image compression when communicating the GPU. Requires CUDA and an NVIDIA GPU.
PARAVIEW_ENABLE_GDAL (default OFF): Enable support for reading GDAL files.
PARAVIEW_ENABLE_LAS (default OFF): Enable support for reading LAS files.
PARAVIEW_ENABLE_OPENTURNS (default OFF): Enable support for reading OpenTURNS files.
PARAVIEW_ENABLE_PDAL (default OFF): Enable support for reading PDAL files.
PARAVIEW_ENABLE_MOTIONFX (default OFF): Enable support for reading MotionFX files.
PARAVIEW_ENABLE_MOMENTINVARIANTS (default OFF): Enable MomentInvariants filters.
PARAVIEW_ENABLE_XDMF2 (default OFF): Enable support for reading Xdmf2 files.
PARAVIEW_ENABLE_XDMF3 (default OFF): Enable support for reading Xdmf3 files.
PARAVIEW_ENABLE_FFMPEG (default OFF; not available on Windows): Enable FFmpeg support.
PARAVIEW_ENABLE_COSMOTOOLS (default OFF; requires PARAVIEW_USE_MPI and not available on Windows): Enable support for CosmoTools which includes GenericIO readers and writers as well as some point cloud algorithms.
PARAVIEW_USE_MPI_SSEND (default OFF; requires PARAVIEW_USE_MPI): Use synchronous send commands for communication.
PARAVIEW_USE_ICE_T (default OFF; requires PARAVIEW_USE_MPI): Use Ice-T for parallel rendering.
PARAVIEW_INITIALIZE_MPI_ON_CLIENT (default ON; requires PARAVIEW_USE_MPI): Initialize MPI on client processes by default.
PARAVIEW_ENABLE_QT_SUPPORT (default OFF; implied by PARAVIEW_BUILD_QT_GUI): Enable Qt support.
PARAVIEW_USE_QTHELP (default ON; requires PARAVIEW_ENABLE_QT_SUPPORT): Use Qt's help infrastructure for runtime documentation.
PARAVIEW_ENABLE_COMMANDLINE_TOOLS (default ON; implied by PARAVIEW_BUILD_QT_GUI): Build command line tools such as pvserver and pvrenderserver.
PARAVIEW_USE_EXTERNAL (default OFF): Whether to prefer external third party libraries or the versions ParaView's source contains.
PARAVIEW_VERSIONED_INSTALL (default ON): Whether to add version numbers to ParaView's include and plugin directories in the install tree.
PARAVIEW_CUSTOM_LIBRARY_SUFFIX (default depends on PARAVIEW_VERSIONED_INSTALL): The custom suffix for libraries built by ParaView. Defaults to either an empty string or pvX.Y where X and Y are ParaView's major and minor version components, respectively.
PARAVIEW_PLUGINS_DEFAULT (default ON): The state for ParaView's set of enabled-by-default plugins. Note that this variable only really has an effect on initial configures or newly added plugins.
PARAVIEW_INSTALL_DEVELOPMENT_FILES (default ON): If set, ParaView will install its headers, CMake API, etc. into its install tree for use.
PARAVIEW_RELOCATABLE_INSTALL (default ON): If set, the install tree will be relocatable to another path. If unset, the install tree may be tied to the build machine with absolute paths, but finding dependencies in non-standard locations may require work without passing extra information when consuming ParaView.
@Neumann-A Neumann-A added the category:new-port The issue is requesting a new library to be added; consider making a PR! label Dec 2, 2019
@Neumann-A
Copy link
Contributor Author

duplicate of #5330 but with more details

@PhoebeHui PhoebeHui removed their assignment Dec 3, 2019
@PhoebeHui PhoebeHui added the info:good-first-issue This issue would be a good issue to get one's feet wet in solving. label Dec 3, 2019
@Neumann-A
Copy link
Contributor Author

@PhoebeHui This is definitly not a "good first issue". It is complicated as hell and I am currently working on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:new-port The issue is requesting a new library to be added; consider making a PR! info:good-first-issue This issue would be a good issue to get one's feet wet in solving.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants