imincik / geospatial-nix

Geospatial packages repository and environment. Check out https://geospatial-nix.today/ .

Geospatial packages repository and environment

Geospatial NIX provides weekly updated geospatial packages and tools built on top of latest stable Nixpkgs branch for creating isolated and reproducible geospatial environments. Check out the user interface at https://geospatial-nix.today/ .

Quick start

Install and configure Nix

• Install Nix

sh <(curl -L https://nixos.org/nix/install) --daemon

• Enable new Nix command interface and Nix Flakes

echo "experimental-features = nix-command flakes" | sudo tee -a /etc/nix/nix.conf

• Add current user to Nix trusted users group

echo "trusted-users = $USER" | sudo tee -a /etc/nix/nix.conf

• Restart Nix daemon

sudo systemctl restart nix-daemon.service

Show content

• Show Geospatial NIX content

nix flake show github:imincik/geospatial-nix

Run applications without installation

• Launch latest stable QGIS version

nix run github:imincik/geospatial-nix#qgis

• Launch QGIS LTR version

nix run github:imincik/geospatial-nix#qgis-ltr

Create new environment

• Initialize new environment

mkdir my-project
cd my-project

git init

nix run github:imincik/geospatial-nix#geonixcli init

git add *

• Edit geonix.nix file according your project requirements (check out examples for example configurations)

• Launch shell environment

nix run github:imincik/geospatial-nix#geonixcli shell

More information about used technologies

• Nix documentation
• Devenv

Developer documentation

Building packages

• Build single package

nix build .#<PACKAGE>

• Build all packages

nix build .#all-packages

• Build single package and push it to Geonix binary cache

nix build --json .#<PACKAGE>  | jq -r '.[].outputs | to_entries[].value' | cachix push geonix

• Build all packages and push them to Geonix binary cache

nix build --json .#all-packages  | jq -r '.[].outputs | to_entries[].value' | cachix push geonix

• Run package passthru tests

nix build -L .#<PACKAGE>.tests.<TEST-NAME>

To re-build already built package or to re-run already succeeded tests use --rebuild switch.

Debugging packages

• Explore derivation

nix show-derivation .#<PACKAGE>

• Explore package store path content

nix path-info -rsSh .#<PACKAGE> | sort -nk3

• Explain package dependencies

nix why-depends .#<PACKAGE> .#<DEPENDENCY>

Weekly development cycle

• Monday (1 AM): automatic update of base packages from latest stable Nixpkgs branch (nix flake update)

• Monday - Wednesday: development and updates of geospatial packages in Nixpkgs master

• Thursday - Friday: pull from Nixpkgs master to Geospatial NIX master, integration, testing

• Monday (1 AM): automatic release of new version

Nixpkgs pull process

• Create nixpkgs-pull branch

git checkout -b nixpkgs-pull-$(date "+%Y%m%d")

• Pull from latest Nixpkgs master

utils/pull-nixpkgs.sh <NIXPKGS-DIR>

• Review changes, identify related PRs in Nixpkgs, split changes to separate commits (link to Nixpks PR in commit message)

• Optional: generate reverse patch for changes which are not desired

git diff -R <CHANGED-FILE> > pkgs/<PACKAGE>/nixpkgs/<PATCH-NAME>.patch

• Build and test all packages

nix build --json .#all-packages  | jq -r '.[].outputs | to_entries[].value' | cachix push geonix

nix flake check

nix build --json .\#test-qgis.x86_64-linux  | jq -r '.[].outputs | to_entries[].value' | cachix push geonix
nix build --json .\#test-qgis-ltr.x86_64-linux  | jq -r '.[].outputs | to_entries[].value' | cachix push geonix

• Submit PR

gh pr create --title "pkgs: nixpkgs weekly pull <TIMESTAMP>"