deepsensor 0.4.2__tar.gz → 0.4.3__tar.gz

deepsensor-0.4.3/.all-contributorsrc

@@ -0,0 +1,225 @@
+{
+  "projectName": "deepsensor",
+  "projectOwner": "alan-turing-institute",
+  "skipCI": true,
+  "files": [
+    "README.md"
+  ],
+  "commitType": "docs",
+  "commitConvention": "angular",
+  "contributorsPerLine": 7,
+  "contributorsSortAlphabetically": true,
+  "contributors": [
+    {
+      "login": "kallewesterling",
+      "name": "Kalle Westerling",
+      "avatar_url": "https://avatars.githubusercontent.com/u/7298727?v=4",
+      "profile": "http://www.westerling.nu",
+      "contributions": [
+        "doc",
+        "infra",
+        "ideas",
+        "projectManagement",
+        "promotion",
+        "question"
+      ]
+    },
+    {
+      "login": "tom-andersson",
+      "name": "Tom Andersson",
+      "avatar_url": "https://avatars.githubusercontent.com/u/26459412?v=4",
+      "profile": "https://www.bas.ac.uk/profile/tomand",
+      "contributions": [
+        "code",
+        "research",
+        "maintenance",
+        "bug",
+        "test",
+        "tutorial",
+        "doc",
+        "review",
+        "talk",
+        "question"
+      ]
+    },
+    {
+      "login": "acocac",
+      "name": "Alejandro ©",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13321552?v=4",
+      "profile": "https://github.com/acocac",
+      "contributions": [
+        "userTesting",
+        "bug",
+        "mentoring",
+        "ideas",
+        "research",
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "wesselb",
+      "name": "Wessel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1444448?v=4",
+      "profile": "http://wessel.ai",
+      "contributions": [
+        "research",
+        "code",
+        "ideas"
+      ]
+    },
+    {
+      "login": "scotthosking",
+      "name": "Scott Hosking",
+      "avatar_url": "https://avatars.githubusercontent.com/u/10783052?v=4",
+      "profile": "https://scotthosking.com",
+      "contributions": [
+        "fundingFinding",
+        "ideas",
+        "projectManagement"
+      ]
+    },
+    {
+      "login": "patel-zeel",
+      "name": "Zeel B Patel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/59758528?v=4",
+      "profile": "http://patel-zeel.github.io",
+      "contributions": [
+        "bug",
+        "code",
+        "userTesting",
+        "ideas"
+      ]
+    },
+    {
+      "login": "jonas-scholz123",
+      "name": "Jonas Scholz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/37850411?v=4",
+      "profile": "https://github.com/jonas-scholz123",
+      "contributions": [
+        "userTesting",
+        "research",
+        "code",
+        "bug",
+        "ideas"
+      ]
+    },
+    {
+      "login": "nilsleh",
+      "name": "Nils Lehmann",
+      "avatar_url": "https://avatars.githubusercontent.com/u/35272119?v=4",
+      "profile": "https://nilsleh.info/",
+      "contributions": [
+        "ideas",
+        "userTesting",
+        "bug"
+      ]
+    },
+    {
+      "login": "kenzaxtazi",
+      "name": "Kenza Tazi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/43008274?v=4",
+      "profile": "http://kenzaxtazi.github.io",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "polpel",
+      "name": "Paolo Pelucchi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/56694450?v=4",
+      "profile": "https://github.com/polpel",
+      "contributions": [
+        "userTesting",
+        "bug"
+      ]
+    },
+    {
+      "login": "RohitRathore1",
+      "name": "Rohit Singh Rathaur",
+      "avatar_url": "https://avatars.githubusercontent.com/u/42641738?v=4",
+      "profile": "https://rohitrathore.netlify.app/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "magnusross",
+      "name": "Magnus Ross",
+      "avatar_url": "https://avatars.githubusercontent.com/u/51709759?v=4",
+      "profile": "http://magnusross.github.io/about",
+      "contributions": [
+        "tutorial",
+        "data"
+      ]
+    },
+    {
+      "login": "annavaughan",
+      "name": "Anna Vaughan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/45528489?v=4",
+      "profile": "https://github.com/annavaughan",
+      "contributions": [
+        "research"
+      ]
+    },
+    {
+      "login": "ots22",
+      "name": "ots22",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5434836?v=4",
+      "profile": "https://github.com/ots22",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "JimCircadian",
+      "name": "Jim Circadian",
+      "avatar_url": "https://avatars.githubusercontent.com/u/731727?v=4",
+      "profile": "http://inconsistentrecords.co.uk",
+      "contributions": [
+        "ideas",
+        "projectManagement",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "davidwyld",
+      "name": "David Wyld",
+      "avatar_url": "https://avatars.githubusercontent.com/u/24752124?v=4",
+      "profile": "http://davidwyld.uk",
+      "contributions": [
+        "doc",
+        "test",
+        "maintenance",
+        "bug"
+      ]
+    },
+    {
+      "login": "vinayakrana",
+      "name": "vinayakrana",
+      "avatar_url": "https://avatars.githubusercontent.com/u/95575600?v=4",
+      "profile": "https://github.com/vinayakrana",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "DaniJonesOcean",
+      "name": "Dani Jones",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11757453?v=4",
+      "profile": "https://github.com/DaniJonesOcean",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "holzwolf",
+      "name": "holzwolf",
+      "avatar_url": "https://avatars.githubusercontent.com/u/135216528?v=4",
+      "profile": "https://github.com/holzwolf",
+      "contributions": [
+        "bug"
+      ]
+    }
+  ]
+}

deepsensor-0.4.3/.gitattributes

@@ -0,0 +1 @@
+notebooks/** linguist-vendored

deepsensor-0.4.3/.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -0,0 +1,57 @@
+name: "🐛 Bug Report"
+description: Report a suspected bug in the DeepSensor package.
+title: "Potential bug: <title>"
+labels: [
+  "bug"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Please enter a specific description of your issue
+      placeholder: Short and specific description of your incident...
+    validations:
+      required: true
+  - type: textarea
+    id: reprod
+    attributes:
+      label: "Reproduction steps"
+      description: Please enter the steps that you took so we can try to reproduce the issue.
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: version
+    attributes:
+      label: "Version"
+      description: Please tell us which version of DeepSensor you're using.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+      value: |
+        ![DESCRIPTION](LINK.png)
+      render: bash
+    validations:
+      required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: Which OS are you using?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac
+    validations:
+      required: false

deepsensor-0.4.3/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -0,0 +1,55 @@
+name: "💡 Feature Request"
+description: Submit a new feature request for the DeepSensor package.
+title: "Potential new feature: <title>"
+labels: [
+  "enhancement"
+]
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: "Summary"
+      description: Provide a brief explanation of the feature.
+      placeholder: Describe your feature request in a few lines.
+    validations:
+      required: true
+  - type: textarea
+    id: basic_example
+    attributes:
+      label: "Basic Example"
+      description: Indicate here some basic examples of your feature.
+      placeholder: A few specific words about your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: drawbacks
+    attributes:
+      label: "Drawbacks"
+      description: What are the drawbacks/impacts of your feature request?
+      placeholder: Identify the drawbacks and impacts while being neutral on your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: unresolved_question
+    attributes:
+      label: "Unresolved questions"
+      description: What questions still remain unresolved?
+      placeholder: Identify any unresolved issues.
+    validations:
+      required: false
+  - type: textarea
+    id: implementation_pr
+    attributes:
+      label: "Implementation PR"
+      description: Pull request used (if you have submitted a pull request).
+      placeholder: "#<Pull Request ID>"
+    validations:
+      required: false
+  - type: textarea
+    id: reference_issues
+    attributes:
+      label: "Reference Issues"
+      description: Issues that the new feature might resolve (if it addresses any existing issues).
+      placeholder: "#<Issues IDs>"
+    validations:
+      required: false

deepsensor-0.4.3/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Slack channel
+    url: https://ai4environment.slack.com/archives/C05NQ76L87R
+    about: Join our Slack channel to ask and answer questions about DeepSensor.

deepsensor-0.4.3/.github/pull_request_template.md

@@ -0,0 +1,20 @@
+<!-- Thank you for your contribution to DeepSensor! -->
+<!-- Please fill out the details in the pull request description below as appropriate -->
+<!-- Ensure that you abide by the code of conduct -->
+
+## :pencil: Description
+<!-- Please provide a clear description of the changes that are introduced in this pull request and why -->
+<!-- It also helps to explain any justification or options you're aware of -->
+<!-- If this pull request relates to an issue, please include the issue number here, e.g. #42 -->
+
+
+## :white_check_mark: Checklist before requesting a review
+(See the contributing guide for more details on these steps.)
+- [ ] I have installed developer dependencies with `pip install .[dev]` and running `pre-commit install` (or alternatively, manually running `ruff format` before commiting)
+
+If changing or adding source code:
+- [ ] tests are included and are passing (run `pytest`).
+- [ ] documentation is included or updated as relevant, including docstrings.
+
+If changing or adding documentation:
+- [ ] docs build successfully (`jupyter-book build docs --all`) and the changes look good from a manual inspection of the HTML in `docs/_build/html/`.

deepsensor-0.4.3/.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Docs
+on: [push, pull_request, workflow_dispatch]
+permissions:
+    contents: write
+jobs:
+    docs:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-python@v5
+              with:
+                python-version: 3.11
+            - uses: nikeee/setup-pandoc@v1
+            - name: "Upgrade pip"
+              run: pip install --upgrade pip
+            - name: "Install dependencies"
+              run: pip install -e .[docs]
+            - name: "Run jupyter-book"
+              run: jupyter-book build docs --all
+            - name: "Verify Jupyter Book output"
+              run: |
+                echo "Contents of docs/_build/html:"
+                ls -la docs/_build/html || exit 1
+                test -f docs/_build/html/index.html
+            - name: "Deploy"
+              uses: peaceiris/actions-gh-pages@v4
+              if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs') }}
+              with:
+                    publish_branch: gh-pages
+                    github_token: ${{ secrets.GITHUB_TOKEN }}
+                    publish_dir: docs/_build/html/
+                    force_orphan: true

deepsensor-0.4.3/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+# This workflow will upload a Python package using Twine when a release is
+# created. For more information see the following link:
+#     https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ubuntu-latest
+
+    # https://github.com/pypa/gh-action-pypi-publish#trusted-publishing
+    permissions:
+      id-token: write   # IMPORTANT: this permission is mandatory for trusted publishing
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/deepsensor
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -U setuptools wheel twine build
+
+      - name: Build and publish
+        run: python -m build 
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true

deepsensor-0.4.3/.github/workflows/style.yml

@@ -0,0 +1,25 @@
+name: Code Style
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Ruff
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      - name: Check style
+        run: |
+          ruff check

deepsensor-0.4.3/.github/workflows/tests.yml

@@ -0,0 +1,51 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  schedule:
+    - cron: "5 0 * * 2" # run weekly tests
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.9', '3.13']
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Free Disk Space (Ubuntu)
+      uses: jlumbroso/free-disk-space@main
+    - name: Print space
+      run: df -h
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[test,tf,torch]
+    - name: Test with pytest
+      run: pytest
+    - name: Run coveralls
+      run: coveralls --service=github
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_FLAG_NAME: ${{ matrix.test-name }}
+        COVERALLS_PARALLEL: true
+
+
+  finish:
+    name: Finish Coveralls
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Finish Coveralls
+      uses: coverallsapp/github-action@v2
+      with:
+        github-token: ${{ secrets.github_token }}
+        parallel-finished: true

deepsensor-0.4.3/.gitignore

@@ -0,0 +1,14 @@
+*.iml
+*.xml
+*.pyc
+.vscode/
+.DS_Store
+.tox-info.*
+.coverage
+build/
+dist/*
+.tox/
+_build
+*.png
+deepsensor.egg-info/
+.venv/

deepsensor-0.4.3/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.7.0
+  hooks:
+    # Run the linter.
+    - id: ruff
+    # Run the formatter.
+    - id: ruff-format

deepsensor-0.4.3/CITATION.cff

@@ -0,0 +1,42 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: 'DeepSensor: A Python package for modelling environmental data with convolutional neural processes'
+message: >-
+  If you use DeepSensor in your research, please cite it
+  using the information below.
+type: software
+authors:
+  - given-names: Tom Robin
+    family-names: Andersson
+    email: tomandersson3@gmail.com
+    affiliation: Google DeepMind
+    orcid: 'https://orcid.org/0000-0002-1556-9932'
+repository-code: 'https://github.com/alan-turing-institute/deepsensor'
+abstract: >-
+  DeepSensor is a Python package for modelling environmental
+  data with convolutional neural processes (ConvNPs).
+  ConvNPs are versatile deep learning models capable of
+  ingesting multiple environmental data streams of varying
+  modalities and resolutions, handling missing data, and
+  predicting at arbitrary target locations with uncertainty.
+  DeepSensor allows users to tackle a diverse array of
+  environmental prediction tasks, including downscaling
+  (super-resolution), sensor placement, gap-filling, and
+  forecasting. The library includes a user-friendly
+  pandas/xarray interface, automatic unnormalisation of
+  model predictions, active learning functionality,
+  integration with both PyTorch and TensorFlow, and model
+  customisation. DeepSensor streamlines and simplifies the
+  environmental data modelling pipeline, enabling
+  researchers and practitioners to harness the potential of
+  ConvNPs for complex environmental prediction challenges.
+keywords:
+  - machine learning
+  - environmental science
+  - neural processes
+  - active learning
+license: MIT
+version: 0.4.3
+date-released: '2026-05-06'