Skip to content

docs: Add Paraview Proxy examples #90

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

Merged
merged 4 commits into from
May 14, 2025
Merged

Conversation

mlemayTTE
Copy link
Contributor

This PR adds examples of Paraview plugins.

@mlemayTTE mlemayTTE self-assigned this Apr 29, 2025
@mlemayTTE mlemayTTE changed the title Add Paraview Proxy examples doc: Add Paraview Proxy examples Apr 29, 2025
@mlemayTTE mlemayTTE changed the title doc: Add Paraview Proxy examples docs: Add Paraview Proxy examples Apr 29, 2025
Copy link
Contributor

@paloma-martinez paloma-martinez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this work, it will be very useful.

I made a lots of suggestions, but they are basically all the same, just formatting.

@mlemayTTE mlemayTTE marked this pull request as ready for review May 5, 2025 09:25
Comment on lines +11 to +15
geos_pv_path: Path = Path( __file__ ).parent.parent
sys.path.insert( 0, str( geos_pv_path / "src" ) )
from geos.pv.utils.config import update_paths

update_paths()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in #81, do we keep this system of paths in the code or not ? This is not clear to me

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we must include the paths for PV plugins (see the answer in #81 for more details).

Comment on lines +11 to +16
# update sys.path to load all GEOS Python Package dependencies
geos_pv_path: Path = Path( __file__ ).parent.parent
sys.path.insert( 0, str( geos_pv_path / "src" ) )
from geos.pv.utils.config import update_paths

update_paths()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same remark for paths

Comment on lines +11 to +15
geos_pv_path: Path = Path( __file__ ).parent.parent
sys.path.insert( 0, str( geos_pv_path / "src" ) )
from geos.pv.utils.config import update_paths

update_paths()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same remark for paths

Comment on lines +22 to +27
# update sys.path to load all GEOS Python Package dependencies
geos_pv_path: Path = Path( __file__ ).parent.parent
sys.path.insert( 0, str( geos_pv_path / "src" ) )
from geos.pv.utils.config import update_paths

update_paths()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same remark for paths

Comment on lines 31 to 34
__doc__ = """
Example of a Paraview plugin that runs through time steps.

"""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation does not explain what "running through time steps" means

panel_visibility="default">
<Property name="BoolSingle"/>
</PropertyGroup>""" )
def c03BoolInputsGroup( self: Self ) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be c05BoolInputsGroup

@alexbenedicto alexbenedicto merged commit f45f362 into main May 14, 2025
39 checks passed
av-novikov pushed a commit that referenced this pull request May 19, 2025
* Add Paraview Proxy examples

* linting, formating, typing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants