topotoolbox 0.0.1__tar.gz

topotoolbox-0.0.1/.github/workflows/ci.yaml

@@ -0,0 +1,56 @@
+name: CI
+on:
+  pull_request:    
+  push:
+    branches: ["main"]
+jobs:
+  build-and-test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.10', '3.11']
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+
+      - name: Build and install TopoToolbox
+        run: |
+          pip install .[opensimplex]
+
+      - name: Run tests
+        run: |
+          python -m pytest
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+
+      - name: Install tools
+        run: pip install -r requirements.txt
+
+      - name: Run pylint
+        run: pylint --rcfile=pyproject.toml src/topotoolbox/
+
+      - name: Run type checks
+        run: mypy --ignore-missing-imports src/topotoolbox

topotoolbox-0.0.1/.github/workflows/docs.yaml

@@ -0,0 +1,47 @@
+name: docs
+
+on:
+  push:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Install Pandoc
+        run: sudo apt-get install -y pandoc
+
+      - name: Install Python build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r ${{ github.workspace }}/docs/requirements.txt
+          python3 -m pip install .[opensimplex]
+
+      - name: Build Sphinx documentation
+        working-directory: ${{ github.workspace }}/docs
+        run: |
+          make clean
+          make html
+
+      - name: Package artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ${{ github.workspace }}/docs/_build/html
+
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

topotoolbox-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,88 @@
+name: Create and upload wheels and source distribution
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  make_sdist:
+    name: Make SDist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+
+      - name: Install build
+        run: python -m pip install build
+
+      - name: Build SDist
+        run: python -m build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+  build_wheels:
+    name: Wheel on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest, macos-13]
+        cibw_arch: ["native"]
+        cibw_build: ["cp310-* cp311-* cp312-*"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==2.21.3
+
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_ARCHS: ${{ matrix.cibw_arch }}
+          CIBW_BUILD: ${{ matrix.cibw_build }}
+          CIBW_SKIP: "*musllinux*"
+          CIBW_TEST_REQUIRES: pytest
+          CIBW_TEST_COMMAND: pytest {package}/tests
+          CIBW_TEST_EXTRAS: opensimplex
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+  upload_assets:
+    name: Upload release assets
+    needs: [build_wheels, make_sdist]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+      - name: Upload assets to release
+        run: gh release upload --repo $GITHUB_REPOSITORY $TAG dist/*
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          TAG: ${{ github.event.release.tag_name }}
+  upload-pypi:
+    name: Upload release assets to PyPI
+    needs: [build_wheels, make_sdist]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

topotoolbox-0.0.1/.gitignore

@@ -0,0 +1,26 @@
+# ignore .vscode settings:
+.vscode/
+
+# ignore dist directory
+dist/
+
+# ingnore tests pycache
+tests/__pycache__ 
+
+# ignore build docs
+docs/_build/*
+
+# ignore _autosummary
+docs/_autosummary/*
+
+# ignore _temp
+docs/_temp
+
+# ignore pytest_cache
+.pytest_cache/
+
+# ignore mypy_cache
+.mypy_cache/
+
+# ignore .venv
+.venv/

topotoolbox-0.0.1/CMakeLists.txt

@@ -0,0 +1,30 @@
+cmake_minimum_required(VERSION 3.15)
+
+project(${SKBUILD_PROJECT_NAME}
+  VERSION ${SKBUILD_PROJECT_VERSION}
+  LANGUAGES CXX)
+
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+# include libtopotoolbox
+include(FetchContent)
+FetchContent_Declare(
+  topotoolbox
+  GIT_REPOSITORY https://github.com/TopoToolbox/libtopotoolbox.git
+  GIT_TAG main
+)
+FetchContent_MakeAvailable(topotoolbox)
+
+set(PYBIND11_NEWPYTHON ON)
+find_package(pybind11 CONFIG REQUIRED)
+
+pybind11_add_module(_grid src/lib/grid.cpp)
+target_link_libraries(_grid PRIVATE topotoolbox)
+
+pybind11_add_module(_flow src/lib/flow.cpp)
+target_link_libraries(_flow PRIVATE topotoolbox)
+
+pybind11_add_module(_graphflood src/lib/graphflood.cpp)
+target_link_libraries(_graphflood PRIVATE topotoolbox)
+
+install(TARGETS _grid _flow _graphflood LIBRARY DESTINATION topotoolbox)

topotoolbox-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contribution Guidelines
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of guidelines for contributing to the TopoToolbox Python Library. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug, please report it by opening an issue. Please include:
+
+- A clear and descriptive title.
+- A detailed description of the problem.
+- Steps to reproduce the issue.
+- Any error messages you encountered.
+
+### Suggesting Enhancements
+
+If you have an idea for an enhancement or new feature, please open an issue to discuss it. Please include:
+
+- A clear and descriptive title.
+- A detailed description of the proposed enhancement.
+- Any relevant examples or screenshots.
+
+### Submitting Pull Requests
+
+If you have a patch or new feature that you would like to contribute, please submit a [pull request (PR)](https://guides.github.com/introduction/flow/). Before you do, please ensure the following:
+
+1. Fork the repository and create your branch from `main`.
+2. If you have added code that should be tested, add tests.
+3. If you have changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+
+### Code Style
+
+Please follow the [PEP 8](https://pep8.org/) style guide for Python code. Make sure your code passes the linting tests (`pylint --rcfile=pyproject.toml src/topotoolbox/`, `mypy --ignore-missing-imports src/topotoolbox`) and the pytests (`python -m pytest`). Also add tests for new content you want to contribute.
+
+It may also be a good idea to run pylint without specifying the rcfile to check for potential code smells that need to be addressed.
+
+### Commit Messages
+
+Use [clear and descriptive commit messages](https://cbea.ms/git-commit/). Follow these conventions:
+
+- Use the present tense ("Analyze terrain" not "Analyzed terrain").
+- Use the imperative mood ("Generate contour map" not "Generates contour map").
+- Limit the first line to 50 characters or less. All other lines should not be longer than 72 characters.
+- Reference issues and pull requests liberally.
+
+### Documentation
+
+Improvements to the documentation are always welcome. Please ensure that your changes are clear and concise.
+
+Thank you for contributing!