docs: add citation information

kai-tub · Jul 8, 2024 · ca056a4 · ca056a4
1 parent 947d6b5
commit ca056a4
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 30 deletions.
diff --git a/.github/workflows/nix.yml b/.github/workflows/nix.yml
@@ -19,7 +19,9 @@ jobs:
       - name: Run `nix fmt`
         run: nix fmt -- --check *
       - name: Run `flake checks`
-        run: nix flake check -L
+        # impure is required as the devshell is tested as well
+        # and the devenv devshell requires the `impure` flag
+        run: nix flake check --impure -L
       - name: Create AppImage
         run: nix build .#rico-hdl-AppImage
       - name: Test appimage

diff --git a/README.md b/README.md
@@ -482,6 +482,21 @@ These characteristics make array-structured data formats less suitable for deep-
 
 </details>
 
+## Citation
+
+If you use this work, please cite:
+
+```{bibtex}
+@article{clasen2024refinedbigearthnet,
+  title={reBEN: Refined BigEarthNet Dataset for Remote Sensing Image Analysis},
+  author={Clasen, Kai Norman and Hackel, Leonard and Burgert, Tom and Sumbul, Gencer and Demir, Beg{\"u}m and Markl, Volker},
+  year={2024},
+  eprint={2407.03653},
+  archivePrefix={arXiv},
+  primaryClass={cs.CV},
+  url={https://arxiv.org/abs/2407.03653},
+}
+```
 
 [ben]: https://bigearth.net
 [LMDB]: https://www.symas.com/lmdb

diff --git a/flake.nix b/flake.nix
@@ -27,10 +27,7 @@
   in {
     formatter = eachSystem (system: pkgsFor.${system}.alejandra);
     checks = eachSystem (
-      system: let
-        pkgs = pkgsFor.${system};
-        lib = pkgs.lib;
-      in
+      system:
         {
           pre-commit-check = inputs.pre-commit-hooks.lib.${system}.run {
             src = ./.;
@@ -39,12 +36,6 @@
               trim-trailing-whitespace.enable = true;
             };
           };
-          rico-hdl-test-runner-check =
-            pkgs.runCommandNoCC "rs-encoder-test-runner-check" {
-              nativeBuildInputs = [self.packages.${system}.rico-hdl-test-runner];
-            } ''
-              ${lib.getExe self.packages.${system}.rico-hdl-test-runner} && touch $out
-            '';
         }
         // self.packages.${system}
     );
@@ -68,6 +59,16 @@
             --prefix PATH : ${pkgs.lib.makeBinPath [pkgs.fd]}
         '';
         meta.mainProgram = "rico-hdl";
+        checkPhase = ''
+          export PATH="$out/bin:$PATH"
+          export RICO_HDL_S1_PATH=${./integration_tests/tiffs/BigEarthNet/BigEarthNet-S1}
+          export RICO_HDL_S2_PATH=${./integration_tests/tiffs/BigEarthNet/BigEarthNet-S2}
+          export RICO_HDL_HYSPECNET_PATH=${./integration_tests/tiffs/HySpecNet-11k}
+          export RICO_HDL_LMDB_REF_PATH=${./integration_tests/BigEarthNet_LMDB}
+          export RICO_HDL_UC_MERCED_PATH=${./integration_tests/tiffs/UCMerced_LandUse}
+          export RICO_HDL_EUROSAT_MS_PATH=${./integration_tests/tiffs/EuroSAT_MS}
+          pytest
+        '';
         # Python312 breaks LMDB...
         # python = pkgs.python312;
         # no idea how to write this:
@@ -107,25 +108,6 @@
           skopeo --insecure-policy copy "docker-archive:result" "$DOCKER_REPOSITORY"
         '';
       };
-
-      rico-hdl-test-runner = pkgs.writeShellApplication {
-        name = "rico-hdl-test-runner";
-        runtimeInputs = [
-          rico-hdl
-          (pkgs.python3.withPackages
-            pythonTestDeps)
-        ];
-        text = ''
-          export RICO_HDL_S1_PATH=${./integration_tests/tiffs/BigEarthNet/BigEarthNet-S1}
-          export RICO_HDL_S2_PATH=${./integration_tests/tiffs/BigEarthNet/BigEarthNet-S2}
-          export RICO_HDL_HYSPECNET_PATH=${./integration_tests/tiffs/HySpecNet-11k}
-          export RICO_HDL_LMDB_REF_PATH=${./integration_tests/BigEarthNet_LMDB}
-          export RICO_HDL_UC_MERCED_PATH=${./integration_tests/UCMerced_LandUse}
-          export RICO_HDL_EUROSAT_MS_PATH=${./integration_tests/tiffs/EuroSAT_MS}
-          echo "Running Python integration tests."
-          pytest ${./integration_tests/test_python_integration.py} && echo "Success!"
-        '';
-      };
     });
 
     devShells = eachSystem (system: let