Skip to content

Commit

Permalink
Merge branch 'main' into patch/0.43.1
Browse files Browse the repository at this point in the history
  • Loading branch information
banesullivan committed Dec 14, 2023
2 parents 124840e + b960c22 commit 6939120
Show file tree
Hide file tree
Showing 103 changed files with 2,092 additions and 987 deletions.
11 changes: 11 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/LICENSE @pyvista/admin
/AUTHORS.rst @pyvista/admin
/joss/ @pyvista/admin
/CODE_OF_CONDUCT.md @pyvista/admin
/CODEOWNERS @pyvista/admin
/.github/workflows/auto-approve.yml @pyvista/admin
/.github/workflows/testing-and-deployment.yml @banesullivan
/.github/workflows/docs.yml @banesullivan
/.github/workflows/docker-package.yml @banesullivan
/.github/workflows/vtk-pre-test.yml @banesullivan
/pyvista/trame/ @pyvista/kitware
19 changes: 9 additions & 10 deletions .github/workflows/auto-approve.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,24 @@ name: Approve PRs
on:
workflow_dispatch:
issue_comment:
types: [created, edited]

env:
# sintax: ("tkoyama010" "author2")
ALLOWED_AUTHORS: ("tkoyama010")
types: [created]

jobs:
autoapprove:
# This job only runs for pull request comments
# This job only runs for pull request comments by approved users on creation
name: PR comment
if: ${{ github.event.issue.pull_request }}
if: github.event.issue.pull_request &&
contains(github.event.comment.body, '@pyvista-bot LGTM') && (
github.event.comment.user.login == 'banesullivan' ||
github.event.comment.user.login == 'tkoyama010' ||
github.event.comment.user.login == 'akaszynski'
)
permissions:
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: hmarr/auto-approve-action@v3
if: |
contains(github.event.comment.body, 'LGTM') && contains(env.ALLOWED_AUTHORS, github.event.comment.user.login)
with:
review-message: ":white_check_mark: Approving this PR because [${{ github.event.comment.user.login }}](https://github.com/${{ github.event.comment.user.login }}) said so in [here](${{ github.event.comment.html_url }}) :grimacing:"
review-message: ":white_check_mark: Approving this PR because [${{ github.event.comment.user.login }}](https://github.com/${{ github.event.comment.user.login }}) said so in [here](${{ github.event.comment.html_url }}) :shipit:"
pull-request-number: ${{ github.event.issue.number }}
github-token: ${{ secrets.PYVISTA_BOT_TOKEN }}
15 changes: 0 additions & 15 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -93,21 +93,6 @@ jobs:
if: always()
run: if [ -e doc/errors.txt ]; then cat doc/errors.txt; fi

- name: Preview HTML documentation
uses: nwtgck/actions-netlify@v2.1
with:
publish-dir: doc/_build/html/
production-branch: main
github-token: ${{ secrets.GITHUB_TOKEN }}
deploy-message: "Deploy from GitHub Actions"
enable-pull-request-comment: true
enable-commit-comment: true
overwrites-pull-request-comment: true
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
timeout-minutes: 10

- name: Upload HTML documentation
if: always()
uses: actions/upload-artifact@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/label.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
with:
labels: maintenance
- uses: actions-ecosystem/action-add-labels@v1
if: startsWith(github.event.pull_request.head.ref, 'junk')
if: startsWith(github.event.pull_request.head.ref, 'junk') || github.actor == 'dependabot[bot]' || github.actor == 'github-actions[bot]' || github.actor == 'pre-commit-ci[bot]'
with:
labels: ignore-for-release
- uses: actions-ecosystem/action-add-labels@v1
Expand Down
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,9 @@ repos:
rev: 0.27.2
hooks:
- id: check-github-workflows

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.1.7
hooks:
- id: ruff
args: [ --fix ]
38 changes: 18 additions & 20 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
cff-version: 1.2.0
message: "If you are using PyVista in your research, please help our scientific visibility by citing our work!"
preferred-citation:
type: article
authors:
- family-names: "Sullivan"
given-names: "Bane"
orcid: "https://orcid.org/0000-0001-8628-4566"
- family-names: "Kaszynski"
given-names: "Alexander"
orcid: "https://orcid.org/0000-0002-8232-7212"
doi: "10.21105/joss.01450"
journal: "Journal of Open Source Software"
publisher:
name: "The Open Journal"
month: May
title: "PyVista: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)"
volume: 4
issue: 37
start: 1450
year: 2019
url: "https://github.com/pyvista/pyvista"
type: software
authors:
- family-names: "Sullivan"
given-names: "Bane"
orcid: "https://orcid.org/0000-0001-8628-4566"
- family-names: "Kaszynski"
given-names: "Alexander"
orcid: "https://orcid.org/0000-0002-8232-7212"
doi: 10.21105/joss.01450
journal: "Journal of Open Source Software"
publisher:
name: "The Open Journal"
title: "PyVista: 3D plotting and mesh analysis through a streamlined interface for the Visualization Toolkit (VTK)"
volume: 4
issue: 37
start: 1450
date-released: 2019-05-19
url: "https://github.com/pyvista/pyvista"
18 changes: 10 additions & 8 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ software usage, please create a discussion in the
`Discussions <https://github.com/pyvista/pyvista/discussions>`_
repository where the community can collectively address your questions.

You are also welcome to join us on `Slack <http://slack.pyvista.org>`_,
You are also welcome to join us on `Slack <https://communityinviter.com/apps/pyvista/pyvista>`_,
but Slack should be reserved for ad hoc conversations and community engagement
rather than technical discussions.

Expand Down Expand Up @@ -671,6 +671,12 @@ The first time you build the documentation locally will take a while as all the
examples need to be built. After the first build, the documentation should take
a fraction of the time.

To test this locally you need to run a http server in the html directory with:

.. code:: bash
make serve-html
Clearing the Local Build
^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down Expand Up @@ -782,12 +788,7 @@ branch.
Preview the Documentation
~~~~~~~~~~~~~~~~~~~~~~~~~

Once you have make a Pull Request from the pyvista organization repository branch.
This will automatically deploy the Preview Documentation.
Please check the documentation that is deployed by your Pull Request
before merging.

Once you have make a Pull Request from the forked repository. You can comment
Once you have make a Pull Request. You can comment
`github-actions preview` on a pull request to preview documentation.
Since this command is only available for
`@pyvista/developers <https://github.com/orgs/pyvista/teams/developers>`_ ,
Expand Down Expand Up @@ -877,10 +878,11 @@ created the following will occur:
git tag v$(python -c "import pyvista as pv; print(pv.__version__)")
8. Please check again that the tag has been created correctly and push the tag.
8. Please check again that the tag has been created correctly and push the branch and tag.

.. code:: bash
git push origin HEAD
git push origin --tags
9. Create a list of all changes for the release. It is often helpful to
Expand Down
19 changes: 12 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ PyVista
:alt: pyvista


.. |zenodo| image:: https://zenodo.org/badge/92974124.svg
:target: https://zenodo.org/badge/latestdoi/92974124
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8415866.svg
:target: https://zenodo.org/records/8415866

.. |joss| image:: http://joss.theoj.org/papers/10.21105/joss.01450/status.svg
:target: https://doi.org/10.21105/joss.01450
Expand All @@ -23,16 +23,16 @@ PyVista
:target: https://github.com/pyvista/pyvista/actions/workflows/testing-and-deployment.yml

.. |codecov| image:: https://codecov.io/gh/pyvista/pyvista/branch/main/graph/badge.svg
:target: https://codecov.io/gh/pyvista/pyvista
:target: https://app.codecov.io/gh/pyvista/pyvista

.. |codacy| image:: https://app.codacy.com/project/badge/Grade/779ac6aed37548839384acfc0c1aab44
:target: https://www.codacy.com/gh/pyvista/pyvista/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pyvista/pyvista&amp;utm_campaign=Badge_Grade
:target: https://app.codacy.com/gh/pyvista/pyvista/dashboard

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:target: https://opensource.org/license/mit/

.. |slack| image:: https://img.shields.io/badge/Slack-pyvista-green.svg?logo=slack
:target: http://slack.pyvista.org
:target: https://communityinviter.com/apps/pyvista/pyvista

.. |PyPIact| image:: https://img.shields.io/pypi/dm/pyvista.svg?label=PyPI%20downloads
:target: https://pypi.org/project/pyvista/
Expand Down Expand Up @@ -60,6 +60,9 @@ PyVista
.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/pyvista/pyvista/main.svg
:target: https://results.pre-commit.ci/latest/github/pyvista/pyvista/main

.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Ruff

+----------------------+------------------------+-------------+
| Deployment | |pypi| | |conda| |
Expand All @@ -80,6 +83,8 @@ PyVista
+----------------------+------------------------+-------------+
| Formatter | |black| | |isort| |
+----------------------+------------------------+-------------+
| Linter | |Ruff| |
+----------------------+------------------------+-------------+
| Affiliated | |NumFOCUS Affiliated| |
+----------------------+------------------------+-------------+

Expand Down Expand Up @@ -166,7 +171,7 @@ where the community can collectively address your questions. You are also
welcome to join us on Slack_.

.. _pyvista/discussions: https://github.com/pyvista/pyvista/discussions
.. _Slack: http://slack.pyvista.org
.. _Slack: https://communityinviter.com/apps/pyvista/pyvista


Installation
Expand Down
5 changes: 5 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,8 @@ linkcheck:

linkcheck-grep:
@! grep -h "^.*:.*: \[\(\(local\)\|\(broken\)\)\]" _build/linkcheck/output.txt

# Spin up a local http server to view the rendered documentation.
# This is required for interactive examples to work.
serve-html:
python -m http.server 11000 --directory "$(BUILDDIR)"/html
6 changes: 4 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import pyvista
from pyvista.core.errors import PyVistaDeprecationWarning
from pyvista.core.utilities.docs import linkcode_resolve, pv_html_page_context # noqa: F401
from pyvista.plotting.utilities.sphinx_gallery import DynamicScraper

# Manage errors
pyvista.set_error_output_file("errors.txt")
Expand Down Expand Up @@ -73,6 +74,7 @@
"numpydoc",
"pyvista.ext.coverage",
"pyvista.ext.plot_directive",
"pyvista.ext.viewer_directive",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.linkcode", # This adds the button ``[Source]`` to each Python API site by calling ``linkcode_resolve``
Expand Down Expand Up @@ -358,7 +360,7 @@ def __repr__(self):
"backreferences_dir": None,
# Modules for which function level galleries are created. In
"doc_module": "pyvista",
"image_scrapers": ("pyvista", "matplotlib"),
"image_scrapers": (DynamicScraper(), "matplotlib"),
"first_notebook_cell": "%matplotlib inline",
"reset_modules": (reset_pyvista,),
"reset_modules_order": "both",
Expand Down Expand Up @@ -450,7 +452,7 @@ def get_version_match(semver):
"icon_links": [
{
"name": "Slack Community",
"url": "http://slack.pyvista.org",
"url": "https://communityinviter.com/apps/pyvista/pyvista",
"icon": "fab fa-slack",
},
{
Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ where the community can collectively address your questions. You are also
welcome to join us on Slack_.

.. _pyvista/discussions: https://github.com/pyvista/pyvista/discussions
.. _Slack: http://slack.pyvista.org
.. _Slack: https://communityinviter.com/apps/pyvista/pyvista
.. _info@pyvista.org: mailto:info@pyvista.org


Expand Down
10 changes: 7 additions & 3 deletions doc/source/getting-started/why.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ object in VTK cannot. It then makes sense that a
:func:`pyvista.PolyDataFilters.subdivide` method be added to the existing
triangular surface mesh. That way, subdivision can be performed with:

.. jupyter-execute::
.. pyvista-plot::
:context:

import pyvista
mesh = pyvista.Plane().triangulate()
Expand All @@ -120,7 +121,9 @@ meshes. This data can be easily accessed from the dataset attributes
like :attr:`pyvista.DataSet.points`. For example the first 10 points
of a circle from pyvista can be accessed with:

.. jupyter-execute::
.. pyvista-plot::
:context:
:nofigs:

circle = pyvista.Circle()
circle.points[:10]
Expand All @@ -132,7 +135,8 @@ At the same time, a variety of PyVista objects can be generated
directly from numpy arrays. For example, below we generate a vector
field of arrows using :func:`numpy.meshgrid`:

.. jupyter-execute::
.. pyvista-plot::
:context:

import pyvista
import numpy as np
Expand Down
Loading

0 comments on commit 6939120

Please sign in to comment.