ParaView issueshttps://gitlab.kitware.com/paraview/paraview/-/issues2023-08-23T13:12:04-04:00https://gitlab.kitware.com/paraview/paraview/-/issues/22249Move all relevant information from the wiki to the documentation and bring it...2023-08-23T13:12:04-04:00Mathieu Westphal (Kitware)Move all relevant information from the wiki to the documentation and bring it downTime and time again, the wiki keeps popping up on discourse, misguidded user keep using it as a reliable source of information, which it is not.
However, it does contains interesting sources of information that we may not want to loose.
...Time and time again, the wiki keeps popping up on discourse, misguidded user keep using it as a reliable source of information, which it is not.
However, it does contains interesting sources of information that we may not want to loose.
Let migrate all relevant information from the Wiki to the paraview docs and bring it down for good!
First, we will need to list all relevant pages we may want to extract information from, then we need to do it.
Once all is done, just ask sys admins to hide the wiki from the public.
Here is a list of relevant pages:
- [ ] https://www.paraview.org/Wiki/ParaView_Release_Notes: All release notes should be added to a dedicated blog post
- [ ] https://www.paraview.org/Wiki/ParaView_Nightly_Binaries: Should be added somewhere in docs.paraview.org
- [ ] https://www.paraview.org/Wiki/ParaView_And_Mesa_3D: Should be updated and reposted on discourse as a tips and tricks
- [ ] https://www.paraview.org/Wiki/Configuring_Server_Environment_Using_*.pvx_XML_Files: Should be ported to docs.paraview.org
- [ ] https://www.paraview.org/Wiki/Statistical_analysis: Should be ported to docs.paraview.org
- [ ] https://www.paraview.org/Wiki/Writing_Custom_Applications: Should be ported to markdown doc
- [ ] https://www.paraview.org/Wiki/Camera_and_Property_Linking: Should be ported to docs.paraview.org
- [ ] https://www.paraview.org/Wiki/Related_Publications: Should be added to https://www.paraview.org/resources/
- [ ] https://www.paraview.org/Wiki/Testing_design: Relevant information should be ported to md doc
- [ ] https://www.paraview.org/Wiki/Restarted_Simulation_Readers: Should be ported to docs.paraview.org, see below comment to improve the doc.
- [ ] https://www.paraview.org/Wiki/Python_recipes: Put some in discourse tips and tricks
To generate this list, I started from https://www.paraview.org/Wiki/ParaView and followed the site tree map and ensure every link goes purple.
All page not listed here have equivalent in docs.paraview.org, md doc or are not relevant at all.
The effort needed is small and the community will gain a lot to not have misinformation about ParaView lying around.
@cory.quammen @ben.boeckel @wascott
Related to:
https://gitlab.kitware.com/paraview/paraview/-/issues/19078
https://gitlab.kitware.com/paraview/paraview/-/issues/19080
https://gitlab.kitware.com/paraview/paraview/-/issues/18788
https://gitlab.kitware.com/paraview/paraview/-/issues/20725
https://gitlab.kitware.com/paraview/paraview/-/issues/18709
https://gitlab.kitware.com/paraview/paraview/-/issues/17936
https://gitlab.kitware.com/paraview/paraview/-/issues/17543https://gitlab.kitware.com/paraview/paraview/-/issues/22138smTestDriver: add documentation for features supported2023-05-11T08:55:48-04:00Ben BoeckelsmTestDriver: add documentation for features supportedThe following discussion from !6253 should be addressed:
- [ ] @cory.quammen started a [discussion](https://gitlab.kitware.com/paraview/paraview/-/merge_requests/6253#note_1358574): (+1 comment)
> This seems like a reasonable chan...The following discussion from !6253 should be addressed:
- [ ] @cory.quammen started a [discussion](https://gitlab.kitware.com/paraview/paraview/-/merge_requests/6253#note_1358574): (+1 comment)
> This seems like a reasonable change to me. There isn't a clear place for documentation for this environment variables (or the previously existing environment variable), so I suggest just merging as is as it adds a useful feature and the lack of documentation does not make anything worse.
---
`smTestDriver` has all kinds of hidden knobs that we should document. Somewhere.https://gitlab.kitware.com/paraview/paraview/-/issues/20751MinMax documentation is missing/incorrect2021-06-02T11:02:07-04:00Mathieu Westphal (Kitware)MinMax documentation is missing/incorrectThe MinMax filter has no doc in the XML.
This absence of doc make the autmotically generated python gives it the SMProxy doc:
https://kitware.github.io/paraview-docs/latest/python/paraview.simple.MinMax.html#The MinMax filter has no doc in the XML.
This absence of doc make the autmotically generated python gives it the SMProxy doc:
https://kitware.github.io/paraview-docs/latest/python/paraview.simple.MinMax.html#https://gitlab.kitware.com/paraview/paraview/-/issues/20515Number Of Partitions property : truncated label and missing documentation2021-03-02T08:51:57-05:00Nicolas VuailleNumber Of Partitions property : truncated label and missing documentationOn PV master, `Redistribute DataSet` has property label `Number of Partitions` that is truncated, the word `Partitions` is not visible.
![NumberOf](/uploads/9d838f995649d3288e89c5f733582e0e/NumberOf.png)
Also, the default value, -1, is...On PV master, `Redistribute DataSet` has property label `Number of Partitions` that is truncated, the word `Partitions` is not visible.
![NumberOf](/uploads/9d838f995649d3288e89c5f733582e0e/NumberOf.png)
Also, the default value, -1, is not documented.https://gitlab.kitware.com/paraview/paraview/-/issues/20295Document Skybox (IBL, Image Based Lighting)2024-03-07T20:47:17-05:00W. Alan ScottDocument Skybox (IBL, Image Based Lighting)Please document Skybox, IBL, Image Based Lighting. This belongs in the ParaView Guide. Also, please make a ParaView Blog post on Skybox.
OK to add Sandia to this task if needed.Please document Skybox, IBL, Image Based Lighting. This belongs in the ParaView Guide. Also, please make a ParaView Blog post on Skybox.
OK to add Sandia to this task if needed.5.13 (Summer 2024)https://gitlab.kitware.com/paraview/paraview/-/issues/19492Support versions in Python and XML plugins2020-04-14T09:37:06-04:00Ben BoeckelSupport versions in Python and XML pluginsCurrently, there's no way to indicate what version a plugin is if it comes from a Python or XML file.
Discourse: https://discourse.paraview.org/t/indicate-version-for-vtkpythonalgorithmbase-based-python-plugin/3055
Cc: @utkarsh.ayachitCurrently, there's no way to indicate what version a plugin is if it comes from a Python or XML file.
Discourse: https://discourse.paraview.org/t/indicate-version-for-vtkpythonalgorithmbase-based-python-plugin/3055
Cc: @utkarsh.ayachithttps://gitlab.kitware.com/paraview/paraview/-/issues/19218Improve the docs: units are in radians on the Calculator Filter2020-05-07T15:06:16-04:00Pl_WImprove the docs: units are in radians on the Calculator FilterImprove the docs by emphasizing that the Calculator Filter units are in radians and not in degrees.Improve the docs by emphasizing that the Calculator Filter units are in radians and not in degrees.https://gitlab.kitware.com/paraview/paraview/-/issues/19080Outdated Wiki pages2023-08-02T02:22:36-04:00Mathieu Westphal (Kitware)Outdated Wiki pagesThe wiki contains a lot of outdated information.
Here are some that either need to be updated/replaced/removed imo.
* https://www.paraview.org/Wiki/ParaView/ThirdPartyLicenses : @ben.boeckel may know the right way to fix this, could we...The wiki contains a lot of outdated information.
Here are some that either need to be updated/replaced/removed imo.
* https://www.paraview.org/Wiki/ParaView/ThirdPartyLicenses : @ben.boeckel may know the right way to fix this, could we generate something ?
* https://www.paraview.org/Wiki/ParaView:Build_And_Install : Should be replaced by a link to (build.md)[https://github.com/Kitware/ParaView/blob/master/Documentation/dev/build.md]
* https://www.paraview.org/Wiki/ParaView/Binaries : Simply refer to https://gitlab.kitware.com/paraview/paraview-superbuild/tags/ instead of each version
* https://www.paraview.org/Wiki/ParaView/ParaView_Readers_and_Parallel_Data_Distribution : to remove
* https://www.paraview.org/Wiki/ParaView/Plugin_HowTo : Should point to
* https://pluginwizard.mirarco.org/ : to remove
* https://www.paraview.org/Wiki/ParaView/User_Created_Plugins : Should be removed or integrated in ParaView plugins. This is non-builded, non-tested user provided code.
* https://www.paraview.org/Wiki/ParaView/PythonRecipes : We should have a Python Examples stuff, similar to the VTK examples.
* https://www.paraview.org/Wiki/Howtos : This could be removed I supose.
* https://www.paraview.org/Wiki/Related_Publications : We should find a way to keep this up to date somehow
* https://www.paraview.org/Wiki/Time_in_ParaView : Should be removed
* https://www.paraview.org/Wiki/Suggested_online_help_documentation_changes : Should be removed
* https://www.paraview.org/Wiki/ServerManager_XML_Hints : All info should be moved into markdown and available in doc
* https://www.paraview.org/Wiki/ParaView/Guidelines_for_Contributing_Plugins : Should be removed
* https://www.paraview.org/Wiki/Terminology_map : Should be removed
Other pages may need to be updated or moved to the ParaView guide as well.https://gitlab.kitware.com/paraview/paraview/-/issues/19078Reader, Filters and Writers reference wiki page is outdated2023-08-02T02:22:36-04:00Mathieu Westphal (Kitware)Reader, Filters and Writers reference wiki page is outdatedThe references page in the wiki should be replaced by the content of the auto generated Filters, Reader and Writers reference that is available in ParaView.
* https://www.paraview.org/Wiki/ParaView/Users_Guide/List_of_writers
* https://...The references page in the wiki should be replaced by the content of the auto generated Filters, Reader and Writers reference that is available in ParaView.
* https://www.paraview.org/Wiki/ParaView/Users_Guide/List_of_writers
* https://www.paraview.org/Wiki/ParaView/Users_Guide/List_of_filters
* https://www.paraview.org/Wiki/ParaView/Users_Guide/List_of_readers
It actually used to be the case here : https://www.paraview.org/OnlineHelpCurrent/
But this does not exists anymore.
I think this should be generated from the xml files in ParaView.https://gitlab.kitware.com/paraview/paraview/-/issues/18835Provide Guidance on how to compile Catalyst examples2020-05-06T09:28:39-04:00baloeProvide Guidance on how to compile Catalyst examplesIt is currently frustratingly hard to compile the Catalyst examples without instructions on how to do so.
Advice on how to compile and run the examples would be fantastic for people who would like to use Catalyst in their own code.
Ther...It is currently frustratingly hard to compile the Catalyst examples without instructions on how to do so.
Advice on how to compile and run the examples would be fantastic for people who would like to use Catalyst in their own code.
There's a related discourse [here](https://discourse.paraview.org/t/how-does-one-actually-build-the-catalyst-examples/1327/3).
According to Dave DeMarle, at the top of Chapter 5 of the ParaviewCatalyst guide would be a good place for such a guide.https://gitlab.kitware.com/paraview/paraview/-/issues/18804[Module] External Plugins build architecture is hard to understand2024-03-07T20:47:06-05:00Mathieu Westphal (Kitware)[Module] External Plugins build architecture is hard to understandExternal plugin build architecture are hard to understand in ParaView
How to reproduce :
```
cp -r paraview/Examples/ElevationFilter ~/
cd ~/ElevationFilter
mkdir build
cd build
cmake -DParaView_DIR=/path/to/paraview_build/ -...External plugin build architecture are hard to understand in ParaView
How to reproduce :
```
cp -r paraview/Examples/ElevationFilter ~/
cd ~/ElevationFilter
mkdir build
cd build
cmake -DParaView_DIR=/path/to/paraview_build/ -DBUILD_SHARED_LIBS=ON ../
make
```
Note: without BUILD_SHARED_LIBS, only static libs are generated, that should not be the case for an example plugin.
It then contains two .so file
`~/ElevationFilter/build/lib64/libElevationFilters.so`
and
`~/ElevationFilter/build/lib64/paraview/plugins/ElevationFilters.so`
The second one is the one that can be loaded. Not easy to understand. This should be improved.
@ben.boeckel @utkarsh.ayachit5.13 (Summer 2024)https://gitlab.kitware.com/paraview/paraview/-/issues/18788Update plugin wiki docs2023-08-02T02:22:36-04:00Ben BoeckelUpdate plugin wiki docsCc: @utkarsh.ayachitCc: @utkarsh.ayachithttps://gitlab.kitware.com/paraview/paraview/-/issues/18709XML Interface inheritance documentation2023-08-02T02:22:37-04:00Mathieu Westphal (Kitware)XML Interface inheritance documentationXML interface inheritance is hardly documented in our wiki, doxygen and .md files.
It is used without explanation in the plugin wiki page.
https://www.paraview.org/Wiki/ParaView/Plugin_HowTo
It is mentioned without explanation in the p...XML interface inheritance is hardly documented in our wiki, doxygen and .md files.
It is used without explanation in the plugin wiki page.
https://www.paraview.org/Wiki/ParaView/Plugin_HowTo
It is mentioned without explanation in the properties panel wiki page.
https://www.paraview.org/Wiki/ParaView/Properties_Panel
vtkSMProxy doxygen explain what it is used for without giving an example.
https://kitware.github.io/paraview-docs/latest/cxx/classvtkSMProxy.html
I would suggest adding a .md file, in the same idea of ProxyHints.md and also referencing the new example plugin in !2970Mathieu Westphal (Kitware)Mathieu Westphal (Kitware)https://gitlab.kitware.com/paraview/paraview/-/issues/18554Update VTK format guide (PDF)2024-03-07T20:47:50-05:00Sebastien JourdainUpdate VTK format guide (PDF)The PDF that you can find via google search "vtk file format" should be updated to reflect the JSON meta file serie as well as listing the various field data that can be used for encoding real time information when used in time serie or ...The PDF that you can find via google search "vtk file format" should be updated to reflect the JSON meta file serie as well as listing the various field data that can be used for encoding real time information when used in time serie or catalyst channel name.
Those are just 2 fields that come to mind but if any other standard exist they should be listed as well.5.13 (Summer 2024)https://gitlab.kitware.com/paraview/paraview/-/issues/18448Examples of rendering scene (statefile) using OSPRay2018-09-13T16:04:08-04:00Jonathan BorduasExamples of rendering scene (statefile) using OSPRayIt would be of great help to have the different statefile to recreate the examples presented here: https://www.ospray.org/documentation.html#materials.
Such examples would guide a user on how to create a beautiful rendering.It would be of great help to have the different statefile to recreate the examples presented here: https://www.ospray.org/documentation.html#materials.
Such examples would guide a user on how to create a beautiful rendering.https://gitlab.kitware.com/paraview/paraview/-/issues/18327vtkSIMetaReaderProxy's has incorrect documentation2021-03-23T18:42:41-04:00T.J. CoronavtkSIMetaReaderProxy's has incorrect documentationThe documentation for `vtkSIMetaReaderProxy` is a copy/paste from vtkSISourceProxy. It needs its own documentation.The documentation for `vtkSIMetaReaderProxy` is a copy/paste from vtkSISourceProxy. It needs its own documentation.https://gitlab.kitware.com/paraview/paraview/-/issues/17543Create a "Getting your data into VTK/ParaView" guide2024-03-07T20:47:44-05:00W. Alan ScottCreate a "Getting your data into VTK/ParaView" guideFrom an old discussion with Berk. We need to have good documentation on how to get your data into the most common formats in ParaView. Here is Berk and my thread:
I fully agree. We really need to write a "Getting your data into VTK/Pa...From an old discussion with Berk. We need to have good documentation on how to get your data into the most common formats in ParaView. Here is Berk and my thread:
I fully agree. We really need to write a "Getting your data into VTK/ParaView" guide. I would cover these for now:
* VTK formats (legacy and XML)
* Xdmf
* HDF5
* NetCDF
* Exodus
* Plot3D
* Raw binary
I have been wanting this for quite a while now. Maybe 2016 is the time to do it...
-berk
On Wed, Dec 9, 2015 at 2:16 PM, Scott, W Alan wrote:
Excellent, that worked. Thanks!
This needs to be documented somewhere other than in the doxygen/nightly class docs. I never would have figured out your example without your help. Don’t forget that the vast majority of our users aren’t programmers… Why not document it on the Wiki somewhere?
Alan
Subject: Re: [EXTERNAL] Re: plot3d file format with function files
Aha! You need to use the Plot3D reader with the meta-data file for this:
http://www.vtk.org/doc/nightly/html/classvtkPlot3DMetaReader.html
Look at the Web page for the format of the meta-data file. It lets you define a different xyz, q or f file for each timestep. The extension of the meta-data file is p3d. It will look something like this:
{
"auto-detect-format" : true,
"filenames" : [
{ "time" : 0, "xyz" : "mygeom.xyz<http://mygeom.xyz>", "function" : "f0.f" },
{ "time" : 1, "xyz" : "mygeom.xyz<http://mygeom.xyz>", "function" : "f1.f" }
]
}
PS: We don't support multiple function files per timestep.
On Wed, Dec 9, 2015 at 12:23 PM, Scott, W Alan <wascott@sandia.gov<mailto:wascott@sandia.gov>> wrote:
Sorry, I wasn't completely clear.
The question is, what if you have numerous Function Files, one for each timestep? From what I can tell, ParaView won't open more than one file. Am I doing something stupid, or is this a feature hole?
Alan5.13 (Summer 2024)https://gitlab.kitware.com/paraview/paraview/-/issues/17504Help/ Readers Filters and Sources list is incomplete2020-05-05T03:16:20-04:00W. Alan ScottHelp/ Readers Filters and Sources list is incompleteThe Help/ Readers, Filters and Sources help is incomplete. Both make sure all filters and sources are listed, and make sure they all have text explaining what they do.The Help/ Readers, Filters and Sources help is incomplete. Both make sure all filters and sources are listed, and make sure they all have text explaining what they do.https://gitlab.kitware.com/paraview/paraview/-/issues/16966Add documentation to ParaView guide on widget control2024-03-07T20:47:42-05:00W. Alan ScottAdd documentation to ParaView guide on widget controlPlease add some verbiage to the ParaView guide on controlling widgets. Especially document the X, Y and Z functionality.Please add some verbiage to the ParaView guide on controlling widgets. Especially document the X, Y and Z functionality.5.13 (Summer 2024)https://gitlab.kitware.com/paraview/paraview/-/issues/16741Clarify the properties tab "Transforming"2020-05-05T04:55:20-04:00Kitware RobotClarify the properties tab "Transforming"**This issue was created automatically from an original [Mantis Issue](http://paraview.org/Bug/view.php?id=16741). Further discussion may take place here.**
---
Please clarify the word Transforming in the Properties tab. Maybe change ...**This issue was created automatically from an original [Mantis Issue](http://paraview.org/Bug/view.php?id=16741). Further discussion may take place here.**
---
Please clarify the word Transforming in the Properties tab. Maybe change it to "Transforming the display".
I keep having users think this is transforming the data in the reader, with said dataset transformed in later filters. This is not the case.