pytetwild 0.1.0__tar.gz

pytetwild-0.1.0/.github/workflows/build-and-deploy.yml

@@ -0,0 +1,135 @@
+name: Build and upload
+
+on:
+  pull_request:
+  push:
+    tags:
+      - "*"
+    branches:
+      - "main"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-15-intel, macos-15]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Setup Miniconda (Windows)
+        if: runner.os == 'Windows'
+        uses: conda-incubator/setup-miniconda@v3.0.3
+
+      - name: Install Dependencies (Windows)
+        if: runner.os == 'Windows'
+        shell: powershell
+        run: conda install -c conda-forge mpir zlib -y
+
+      - name: Set env (Windows)
+        if: runner.os == 'Windows'
+        run: |
+          echo "appdata=$env:LOCALAPPDATA" >> ${env:GITHUB_ENV}
+          echo "GMP_INC=C:\Miniconda\envs\test\Library\include" >> ${env:GITHUB_ENV}
+          echo "GMP_LIB=C:\Miniconda\envs\test\Library\lib" >> ${env:GITHUB_ENV}
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v3.2.0
+        env:
+          CIBW_ENVIRONMENT_MACOS: 'MACOSX_DEPLOYMENT_TARGET="15.0"'
+          CIBW_ARCHS_MACOS: "auto"
+
+
+      - name: List generated wheels
+        run: ls ./wheelhouse/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: ./wheelhouse/*.whl
+          name: pytetwild-wheel-${{ matrix.os }}
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install \
+          libblas-dev \
+          libboost-filesystem-dev \
+          libboost-system-dev \
+          libboost-thread-dev \
+          libglu1-mesa-dev \
+          libsuitesparse-dev \
+          libxi-dev \
+          libxcursor-dev \
+          libxinerama-dev \
+          libxrandr-dev \
+          libx11-dev \
+          libxcb1-dev \
+          libxau-dev \
+          libxdmcp-dev \
+          xorg-dev \
+          ccache
+
+      - name: Build source distribution
+        run: |
+          pipx run build --sdist
+
+      - name: Validate
+        run: |
+          pip install twine
+          twine check dist/*
+
+      - name: Install from dist/
+        run: |
+          sdist_file=$(ls dist/*.tar.gz)
+          pip install "$sdist_file[dev]"
+
+      - name: Test
+        run: pytest -vv
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: dist/*.tar.gz
+          name: pytetwild-sdist
+
+  release:
+    name: Release
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pytetwild
+    permissions:
+      id-token: write  # this permission is mandatory for trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+      - name: Flatten directory structure
+        run: |
+          mkdir -p dist/
+          find . -name '*.whl' -exec mv {} dist/ \;
+          find . -name '*.tar.gz' -exec mv {} dist/ \;
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          generate_release_notes: true
+          files: |
+            ./**/*.whl

pytetwild-0.1.0/.gitignore

@@ -0,0 +1,78 @@
+# Compiled source #
+###################
+*.pyc
+*.pyd
+*.so
+*.o
+__pycache__/
+
+# OS generated files #
+######################
+.fuse_hidden*
+*~
+
+# Pip generated folders #
+#########################
+*.egg-info/
+build/
+dist/
+
+# MISC
+.mypy_cache
+__tracked_surface.stl
+
+# Mac
+.DS_Store
+**/.DS_Store
+
+# emacs
+*#
+.#
+flycheck*
+
+# vim
+*.swp
+
+# PyCharm
+.idea/
+
+# virtual environments
+venv/
+.venv/
+
+# VSCode
+.vscode/
+
+# skbuild
+_skbuild/
+
+# cmake
+.ninja_deps
+.ninja_log
+.cmake
+CMakeCache.txt
+CMakeFiles/
+CMakeInit.txt
+CPackConfig.cmake
+CPackSourceConfig.cmake
+build.ninja
+cmake_install.cmake
+lib/
+ALL_BUILD.vcxproj
+ALL_BUILD.vcxproj.filters
+INSTALL.vcxproj
+INSTALL.vcxproj.filters
+PACKAGE.vcxproj
+PACKAGE.vcxproj.filters
+PyfTetWildWrapper.dir/
+PyfTetWildWrapper.vcxproj
+PyfTetWildWrapper.vcxproj.filters
+ZERO_CHECK.vcxproj
+ZERO_CHECK.vcxproj.filters
+fTetWildWrapper.sln
+x64/
+Release/
+mpir.dll
+
+# cibuildwheel
+wheelhouse

pytetwild-0.1.0/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "src/fTetWild"]
+	path = src/fTetWild
+	url = https://github.com/MariusCausemann/fTetWild
+[submodule "src/pybind11"]
+	path = src/pybind11
+	url = https://github.com/pybind/pybind11.git

pytetwild-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.4.3
+  hooks:
+    - id: ruff
+      args: [--fix, --exit-non-zero-on-fix]
+      exclude: ^(docs|tests)
+    - id: ruff-format
+
+- repo: https://github.com/keewis/blackdoc
+  rev: v0.3.9
+  hooks:
+  - id: blackdoc
+    exclude: README.rst
+
+- repo: https://github.com/numpy/numpydoc
+  rev: v1.7.0
+  hooks:
+  - id: numpydoc-validation
+    files: ^src/pytetwild
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.6
+  hooks:
+  - id: codespell
+    args: ["--skip=*.vt*"]
+
+- repo: https://github.com/pycqa/pydocstyle
+  rev: 6.3.0
+  hooks:
+  - id: pydocstyle
+    additional_dependencies: [tomli==2.0.1]
+    files: ^src/pytetwild/.*\.py
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+  - id: check-merge-conflict
+  - id: debug-statements
+  - id: trailing-whitespace
+
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v18.1.4
+  hooks:
+  - id: clang-format
+    files: |
+      (?x)^(
+        src/FTetWildWrapper.cpp
+      )$
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.10.0
+  hooks:
+  - id: mypy
+    exclude: ^(docs/|tests)
+    additional_dependencies: [
+    "mypy-extensions==1.0.0",
+    "toml==0.10.2",
+    "npt_promote",
+    "numpy",
+  ]
+
+- repo: https://github.com/python-jsonschema/check-jsonschema
+  rev: 0.28.2
+  hooks:
+    - id: check-github-workflows

pytetwild-0.1.0/CMakeLists.txt

@@ -0,0 +1,41 @@
+cmake_minimum_required(VERSION 3.15...3.26)
+project(fTetWildWrapper)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ./src/pytetwild)
+
+if($ENV{USE_MAVX})
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mavx")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mavx")
+endif()
+
+# Set the path to the fTetWild project
+set(fTetWild_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src/fTetWild")
+
+# Add the pybind11 submodule
+set(PYBIND11_NEWPYTHON ON)
+set(pybind11_DIR "${CMAKE_CURRENT_SOURCE_DIR}/src/pybind11")
+add_subdirectory(${pybind11_DIR})
+
+# Include the fTetWild project as a subdirectory
+add_subdirectory(${fTetWild_DIR} EXCLUDE_FROM_ALL)
+
+pybind11_add_module(PyfTetWildWrapper MODULE "${CMAKE_CURRENT_SOURCE_DIR}/src/FTetWildWrapper.cpp")
+
+# Include directories from fTetWild required for the wrapper
+target_include_directories(PyfTetWildWrapper PUBLIC ${fTetWild_DIR}/src)
+
+# Link the FloatTetwild library (from fTetWild)
+target_link_libraries(PyfTetWildWrapper PRIVATE FloatTetwild)
+target_compile_features(PyfTetWildWrapper PUBLIC cxx_std_11)
+
+if(WIN32)
+    set_target_properties(PyfTetWildWrapper PROPERTIES SUFFIX ".pyd")
+    foreach(OUTPUTCONFIG ${CMAKE_CONFIGURATION_TYPES})
+        string(TOUPPER ${OUTPUTCONFIG} OUTPUTCONFIG_UPPER)
+        set_target_properties(PyfTetWildWrapper PROPERTIES
+            RUNTIME_OUTPUT_DIRECTORY_${OUTPUTCONFIG_UPPER} "${CMAKE_CURRENT_SOURCE_DIR}/src/pytetwild"
+            LIBRARY_OUTPUT_DIRECTORY_${OUTPUTCONFIG_UPPER} "${CMAKE_CURRENT_SOURCE_DIR}/src/pytetwild"
+        )
+    endforeach()
+endif()
+
+install(TARGETS PyfTetWildWrapper LIBRARY DESTINATION ./pytetwild)

pytetwild-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing to Our Project
+
+Thank you for considering contributions to our project! Here's how you can help:
+
+## Setting Up for Development
+
+We're using [scikit-build-core](https://github.com/scikit-build/scikit-build-core) for our build system and building using ``cmake``. You'll need a handful of system dependencies to build locally.
+
+
+### Linux
+On Linux, install the following OS dependencies with:
+
+```
+sudo apt-get update
+sudo apt-get install libblas-dev libboost-filesystem-dev libboost-system-dev libboost-thread-dev libglu1-mesa-dev libsuitesparse-dev xorg-dev ccache -y
+```
+
+### Windows
+
+For contributors using Windows, we also have a setup process to ensure you can compile and test changes locally. Here's how to set up your development environment on Windows:
+
+1. **Install Miniconda**: We use Miniconda to manage dependencies. Install it from [here](https://docs.anaconda.com/free/miniconda/index.html).
+
+2. **Setup Miniconda and Install Dependencies**:
+   ```
+   conda install -c conda-forge mpir -y
+   ```
+
+3. **Configure Environment Variables**:
+   Set the required environment variables for the build. This assumes PowerShell.
+
+   ```
+   $Env:GMP_INC = "C:\Miniconda\Library\include"
+   $Env:GMP_LIB = "C:\Miniconda\Library\lib"
+   ```
+
+   Note: You may need to adjust these paths depending on if you use a non-global conda environment.
+
+### Installation
+To install the library in editable mode:
+
+  1. Clone the repository:
+     ```
+     git clone https://github.com/pyvista/pytetwild
+     ```
+  2. Initialize submodules:
+     ```
+     git submodule update --init --recursive
+     ```
+  3. Install the project in editable mode and include development dependencies:
+     ```
+     pip install -e .[dev]
+     ```
+
+     **Note:** On windows, you'll need to copy the `mpir.dll` to your source directory with:
+     ```
+     python -c "import shutil, os; shutil.copy(os.path.join(os.getenv('GMP_LIB'), '..', 'bin', 'mpir.dll'), './src/pytetwild')"
+     ```
+
+## Code Style and Quality
+
+- **Documentation**: Follow the `numpydoc` style for docstrings.
+- **Linting**: We use `ruff` for code styling to ensure consistency.
+- **Pre-commit**: Utilize `pre-commit` hooks to automate checks before commits. Set up your local environment with:
+  ```
+  pip install pre-commit
+  pre-commit install
+  ```
+- **Testing**: Write tests for new features or bug fixes and run them using `pytest`. Tests are located in the `tests` directory.
+
+## How to Contribute
+
+- **Bugs and Feature Requests**: Submit them through our [issues page](https://github.com/pyvista/pytetwild/issues).
+- **Code Contributions**: Make changes in a fork of this repository and submit a pull request (PR) through our [PR page](https://github.com/pyvista/pytetwild/pulls). Follow the standard fork-and-PR workflow for contributions.
+
+## Community and Conduct
+
+- We expect all contributors to follow our [Code of Conduct](https://github.com/pyvista/pyvista/blob/main/CODE_OF_CONDUCT.md) to maintain a welcoming and inclusive community.
+
+## License
+
+- Contributions are subject to the project's license as found in the [LICENSE.md](./LICENSE.md) file.
+
+We welcome your contributions and look forward to collaborating with you!