Dev: Add flake.nix for creating dev shells with nix.

[joernweissenborn]

This enables user with nix installed to work on pyglotaran. The flake creates a shell with python 3.10 and virtualenv installed and installs all dependencies on first creation.

[github-actions]

👈 Launch a binder notebook on branch joernweissenborn/pyglotaran/dev/add_nix

[github-actions]

Benchmark is done. Checkout the benchmark result page.
Benchmark differences below 5% might be due to CI noise.

Benchmark diff v0.6.0 vs. main

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [6c3c390e]       [356b9345]
     <v0.6.0>                   
!      42.4±0.2ms           failed      n/a  BenchmarkOptimize.time_optimize(False, False, False)
!      44.7±0.3ms           failed      n/a  BenchmarkOptimize.time_optimize(False, False, True)
!      42.3±0.2ms           failed      n/a  BenchmarkOptimize.time_optimize(False, True, False)
!      44.8±0.3ms           failed      n/a  BenchmarkOptimize.time_optimize(False, True, True)
!      52.5±0.2ms           failed      n/a  BenchmarkOptimize.time_optimize(True, False, False)
!        139±10ms           failed      n/a  BenchmarkOptimize.time_optimize(True, False, True)
!      52.3±0.3ms           failed      n/a  BenchmarkOptimize.time_optimize(True, True, False)
!       57.8±10ms           failed      n/a  BenchmarkOptimize.time_optimize(True, True, True)
             206M             208M     1.01  IntegrationTwoDatasets.peakmem_optimize
-      1.87±0.06s       1.03±0.05s     0.55  IntegrationTwoDatasets.time_optimize

Benchmark diff main vs. PR

Parametrized benchmark signatures:

BenchmarkOptimize.time_optimize(index_dependent, grouped, weight)

All benchmarks:

       before           after         ratio
     [356b9345]       [80abd6aa]
           failed           failed      n/a  BenchmarkOptimize.time_optimize(False, False, False)
           failed           failed      n/a  BenchmarkOptimize.time_optimize(False, False, True)
           failed           failed      n/a  BenchmarkOptimize.time_optimize(False, True, False)
           failed           failed      n/a  BenchmarkOptimize.time_optimize(False, True, True)
           failed           failed      n/a  BenchmarkOptimize.time_optimize(True, False, False)
           failed           failed      n/a  BenchmarkOptimize.time_optimize(True, False, True)
           failed           failed      n/a  BenchmarkOptimize.time_optimize(True, True, False)
           failed           failed      n/a  BenchmarkOptimize.time_optimize(True, True, True)
             208M             208M     1.00  IntegrationTwoDatasets.peakmem_optimize
       1.03±0.05s         997±20ms     0.96  IntegrationTwoDatasets.time_optimize

[s-weigand]

Besides the failing pre-commit check please add a short guide on how to set things up in CONTRIBUTING.rst (would also interest me 😅).

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[codecov]

Codecov Report

Base: 88.3% // Head: 88.3% // No change to project coverage 👍

Coverage data is based on head (80abd6a) compared to base (356b934).
Patch has no changes to coverable lines.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #1253   +/-   ##
=====================================
  Coverage   88.3%   88.3%           
=====================================
  Files        104     104           
  Lines       5092    5092           
  Branches     847     847           
=====================================
  Hits        4499    4499           
  Misses       477     477           
  Partials     116     116           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jsnel]

Enjoy working with NixOS!

[s-weigand]

LGTM 👍