Skip to main content

Tests Deployment License: MIT

DTC-IS Gaussian Random Field

The gaussian_random_field module is a sub-component of the Digital Twin Component for Ice Sheets (DTC-IS), an ESA-funded, EO-driven digital twin project.

The gaussian_random_field module fits a Gaussian Random Field to an input field of surface meltwater runoff or supraglacial lake intensity. It was developed to provide hydropower insights for the Watson River catchment area in the Greenland ice sheet.

For an in-depth overview of the gaussian_random_field module please read the docs.

The documentation includes sections on:

  1. Getting started
  2. Scientific overview
  3. API reference

For a more interactive way of exploring the system, please visit the digital twin's dashboard and/or explore the project notebook repository.

Installation

This package has a dependency on R and requires additional R packages and python bindings to be installed. The installation is therefore relatively complex and dependent on your OS/version & python installation. We provide 2 routes towards installation - installing with conda and installing via a dev container.

Conda install

An isolated R installation can be created via conda. Assuming you have conda installed already, a bash install script can be used to setup the environment. From the repository root, the following command can be run:

Prerequisites

  • conda is installed
  • conda is active in your shell
  • you are in your base conda environment (use conda deactivate to exit from a active environment)

Install commands

bash create-conda-env-with-R.sh

The above bash script will create a conda environment for you, dtc_gaussian_random_field. Once your conda env is created, you can install the package with pip:

conda activate dtc_gaussian_random_field # activate the conda environment
pip install gaussian_random_field

Troubleshooting

If the pip install process raises dependency errors - it is very that you have additional packages installed in your base conda environment. Note that dtc_gaussian_random_field inherits packages that are installed in the base conda environment. Use the error messages to guide you which packages to remove before retrying the install process.

Dev container install (quicker/recommended)

For users of VScode, the repository dev container may be a more convenient way to install the package.

Pre-requisites

  1. Install and setup Docker.
  2. clone the repository:
git clone https://github.com/dtc-ice-sheets/gaussian_random_field.git
cd gaussian_random_field

Setup the dev container

  1. Open the cloned repository folder in VSCode.
  2. Click the blue box at the very bottom left of the VSCode window, and then click "Dev Containers: Reopen in Container".
    For more guidance on this, see the dev containers documentation.
  3. Wait for the Docker setup to finish (might take a few minutes).
  4. There should be a popup in the bottom right asking you to install recommended extensions, click "Yes". Otherwise go to the "Extensions" tab and install all the extensions that are marked as recommended.
  5. Click on the "Testing" tab icon on the left of the VSCode window. From there, click "Refresh Tests", and then click "Run Tests". After a short while you should see that all test have passed with a green check.

And that's it!

Note that the list of VSCode projects should now show two copies of this project: one labelled as "dev container", and one not. You should ignore the normal project and make sure to always do all development work inside the dev container project. If you are in the correct project the blue box in the bottom left should start with "Dev Container: ...". If it doesn't, repeat Step 2 to switch to the correct project.

Metadata

Release files for gaussian_random_field 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gaussian_random_field 0.0.2
File Size Uploaded Provenance Actions
gaussian_random_field-0.0.2.tar.gz 36.7 kB Without provenance Details for gaussian_random_field-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gaussian_random_field 0.0.2
File Interpreter ABI Platform Actions
gaussian_random_field-0.0.2-py3-none-any.whl Python 3 none any Details for gaussian_random_field-0.0.2-py3-none-any.whl

Total release size: 74.3 kB

Release files / gaussian_random_field-0.0.2.tar.gz

Download URL gaussian_random_field-0.0.2.tar.gz
Size 36.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2a51b9c5082494ab0d3cf130201f086ac0d2e3a045a6955dfa9d03da0cc3df33
BLAKE2b-256 checksum
How to use checksums
2b8fdaef57bcd8cfdd6f9309a6d37f9e90f4980ca36ef6ce2d89958696aa537f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.18 Linux/7.0.0-1019-azure

Release files / gaussian_random_field-0.0.2-py3-none-any.whl

Download URL gaussian_random_field-0.0.2-py3-none-any.whl
Size 37.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
951ebd17345b3674a7ee9b55cb51d6b17de59fab1afff89501f118861ca3fac8
BLAKE2b-256 checksum
How to use checksums
26a72f090f7f356b500129c689138f5432c279c436bb6ff9c95d5e173ec5ad66
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.13.18 Linux/7.0.0-1019-azure

Security for gaussian_random_field 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page