{"id":44343589,"url":"https://github.com/imcs-compsim/pvutils","last_synced_at":"2026-02-11T13:11:36.722Z","repository":{"id":162482191,"uuid":"590942402","full_name":"imcs-compsim/pvutils","owner":"imcs-compsim","description":null,"archived":false,"fork":false,"pushed_at":"2024-02-13T18:48:35.000Z","size":1759,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-02-13T19:47:35.235Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imcs-compsim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-01-19T15:18:51.000Z","updated_at":"2023-10-17T06:54:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"9759e8b9-7050-4029-a802-53868f57d5eb","html_url":"https://github.com/imcs-compsim/pvutils","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/imcs-compsim/pvutils","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcs-compsim%2Fpvutils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcs-compsim%2Fpvutils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcs-compsim%2Fpvutils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcs-compsim%2Fpvutils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imcs-compsim","download_url":"https://codeload.github.com/imcs-compsim/pvutils/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcs-compsim%2Fpvutils/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29333170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T12:42:24.625Z","status":"ssl_error","status_checked_at":"2026-02-11T12:41:23.344Z","response_time":97,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-11T13:11:36.044Z","updated_at":"2026-02-11T13:11:36.713Z","avatar_url":"https://github.com/imcs-compsim.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pvutils\n\nA set of functions that should simplify the usability of `python` scripts in ParaView.\n\n- The directory `pvuitls` contains the files for this module, utility functions and ParaView filter wrappers. \n- Some useful programmable filters can be found in the directory `filters`.\nTo use one of the programmable filters in a script, use the function `programmable_filter` from `pvutils`.\n\n\n## How to cite\nIf you use `pvutils` to create figures for your work, please acknowledge it with a link to the GitHub repository, for example:\n\n\u003e Illustrations in this work have been created using the ParaView scripting toolbox `pvutils` ([https://github.com/imcs-compsim/pvutils](https://github.com/imcs-compsim/pvutils)).\n\nFeel free to leave us a :star: on [GitHub](https://github.com/imcs-compsim/pvutils).\n\n## ParaView version\n\nThe current version of this module is developed with [ParaView 5.11.2](https://www.paraview.org).\n\n\n## Execute scripts with `pvutils`\n\nThe two basic ways to execute a python ParaView script are:\n\n- Execute with the **ParaView python interpreter** (`pvpython` or `paraview`).\n  Make sure that the path to the root `pvutils` directory is visible for the interpreter.\n  There are several ways to do this, e.g.,\n  - Add the path to the environment variable `PYTHONPATH`\n    ```bash\n    export PYTHONPATH=\"${PYTHONPATH}:${\u003cpath to pvutils\u003e}\n    ```\n  - Add the path from within the python script\n    ```python\n    import sys\n    sys.path.append(\"\u003cpath to pvutils\u003e\")\n    ```\n\n  The call to the script can either be done with the ParaView python wrapper `pvpython` or the main ParaView application itself:\n\n  - Execute the script with the ParaView internal python interpreter.\n    Per default no graphical window is opened.\n    ```bash\n    \u003cpath to ParaView\u003e/bin/pvpython \u003cpath to script\u003e\n    ```\n  - Execute the script with the default ParaView application.\n    A GUI will be opened.\n    ```bash\n    \u003cpath to ParaView\u003e/bin/paraview --script=\u003cpath to script\u003e\n    ```\n\n- Execute with the **system python interpreter**\n  ```bash\n  python3 \u003cpath to script\u003e\n  ```\n  This is the recommended way to add the ParaView script to an existing python workflow.\n  For this to work, certain things have to be considered:\n  - Install `pvutils` in your pip environment\n    ```python\n    # Only use pvutils\n    pip install \u003cpath to pvutils\u003e\n    # Develop pvutils\n    pip install -e \u003cpath to pvutils\u003e\n    ```\n  - Add the path to the ParaView python interface\n    ```bash\n    export PYTHONPATH=\"${PYTHONPATH}:${\u003cpath to ParaView\u003e}/lib/python3.9/site-packages\"\n    ```\n  - Add the path to the ParaView python libraries\n    ```bash\n    export LD_LIBRARY_PATH=\"${LD_LIBRARY_PATH}:${\u003cpath to ParaView\u003e}/lib\"\n    ```\n  - If your existing python workflow depends on binary packages, e.g., `cython` or `numpy`, make sure the libraries provided by ParaView are compatible with your binaries.\n\n\n## Testing\n\nA change in the repository also starts a pipeline in GitLab.\n\nThe unit tests are defined in `tests/testing.pvutils.py`.\n\nTo setup local testing, modify your `~/.bashrc` to\n- point the environment variable `PARAVIEW_PATH` pointing to the root directory of the ParaView installation (the one containing `bin` and `lib`)\n- include the repository `pvutils` into your `PYTHONPATH`.\n\nThen, all tests can be executed by\n- navigating to `tests/`\n- executing `test_local.sh`\n\n\n## Code formatting\n\n`pvutils` uses the the python code formatter [black](https://github.com/psf/black).\nThe testsuite checks that all source files are formatted accordingly.\n\n\n## License\n\n`pvutils` is licensed under the Apache License v2.0 with LLVM Exceptions.\nSee the `LICENSE` file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcs-compsim%2Fpvutils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimcs-compsim%2Fpvutils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcs-compsim%2Fpvutils/lists"}