Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: paper feedback #29

Merged
merged 22 commits into from
Aug 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
c57a045
feat(paper): Add the feedback provided by peer review
cheriimoya Aug 8, 2024
bfdc9e9
fix(ci): Fix treefmt after upstream broke it
cheriimoya Aug 8, 2024
6ef7255
feat: integrate some more feedback into paper and fix tests in fenics…
Conni2461 Aug 12, 2024
17bfbb5
feat: more feedback
Conni2461 Aug 13, 2024
3190406
chore: fix ci
Conni2461 Aug 13, 2024
ddf824a
feat: push remaining feedback changes
Conni2461 Aug 13, 2024
85e17c0
feat: Add MIT license
cheriimoya Aug 13, 2024
e84f348
feat: integrate last feedback
Conni2461 Aug 14, 2024
cb37988
chore: fix some typos
Conni2461 Aug 14, 2024
01bb79f
style: simplify phase description in section 2
Conni2461 Aug 14, 2024
44c5bd1
fix(paper): typo, buildsystem -> build system, remove double space
cheriimoya Aug 15, 2024
f966723
feat(paper): Add paragraph to conclusion
cheriimoya Aug 15, 2024
b7cec2e
Iterate on review changes
uekerman Aug 18, 2024
d918d52
feat: consistent naming for section
Conni2461 Aug 20, 2024
a3c80a6
feat(paper): Minor revisions
cheriimoya Aug 20, 2024
cd3f57c
fix(paper): There are 60 participant cases
cheriimoya Aug 20, 2024
e781a8e
feat(paper): Make Nix' phases consistent
cheriimoya Aug 20, 2024
9c33b9d
Fix spelling mistake (Section)
uekerman Aug 20, 2024
b8bbd57
feat(paper): Explain the coupled solvers
cheriimoya Aug 20, 2024
d48992d
Simplify coupled solvers
uekerman Aug 21, 2024
ef215e1
chore: migrate to lstlisting so we can diff those
Conni2461 Aug 21, 2024
899c812
feat: set updated link for tag
Conni2461 Aug 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .hydra/default.nix
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{ declInput, projectName, ... }: let
{ declInput, projectName, ... }:
let
jobsets = {
flakeJobset = {
enabled = 1;
Expand All @@ -11,10 +12,11 @@
enableemail = false;
emailoverride = "";
keepnr = 3;
inputs = {};
inputs = { };
};
};
in {
in
{
jobsets = derivation {
name = "forschungsprojekt-spec.json";
system = builtins.currentSystem;
Expand Down
29 changes: 18 additions & 11 deletions .hydra/release.nix
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,27 @@ let
names = builtins.attrNames ((builtins.elemAt precicePkgs 1) { } { });

# Generate attrs in form `packagename = pkgs.packagename;`
packages = builtins.listToAttrs (builtins.map (name: { inherit name; value = pkgs."${name}"; }) names);
packages = builtins.listToAttrs (
builtins.map (name: {
inherit name;
value = pkgs."${name}";
}) names
);

# $ NIXOS_CONFIG=$PWD/configuration.nix nix repl '<nixpkgs/nixos>'
# nix-repl> config.system.build.vm
# vm = (pkgs.nixos { configuration}).config.system.build.vm
inherit ((import <nixpkgs/nixos/lib/eval-config.nix> {
modules = [
../configuration.nix
{
nixpkgs.pkgs = pkgs;
}
];
}).config.system.build) vm;
inherit
((import <nixpkgs/nixos/lib/eval-config.nix> {
modules = [
../configuration.nix
{ nixpkgs.pkgs = pkgs; }
];
}).config.system.build
)
vm
;

in
# These are the separate jobs that are generated
packages // { inherit vm; }
# These are the separate jobs that are generated
packages // { inherit vm; }
22 changes: 22 additions & 0 deletions paper/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
MIT License

Copyright (c) 2024 preCICE

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Binary file modified paper/figures/coreutils.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion paper/paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ @techreport{studentreport
title={Improving reproducibility of scientific software using Nix/NixOS},
author={Max Hausch and Simon Hauser},
year={2023},
url={https://github.com/precice/nix-packages/releases/download/initial-paper-release/hauser-hausch-research-paper-cb56c9362bf1a2bd1b18873dd36c05b5a082097c.pdf},
url={https://github.com/precice/nix-packages/releases/tag/initial-paper-release},
institution = {University of Stuttgart}
}
@article{Dalle_2012,
Expand Down
271 changes: 180 additions & 91 deletions paper/paper.tex

Large diffs are not rendered by default.

17 changes: 8 additions & 9 deletions precice-packages/precice-fenics-adapter/default.nix
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
lib,
fetchPypi,
fetchFromGitHub,
python3,
precice,
fenics,
Expand All @@ -14,10 +14,11 @@ python3.pkgs.buildPythonPackage rec {
pname = "precice-fenics-adapter";
version = "1.4.0";

src = fetchPypi {
pname = "fenicsprecice";
inherit version;
hash = "sha256-ux5qi4SGGHETbldfEiT8H/7Pvmn2uvQwDFB1wi/pAKI=";
src = fetchFromGitHub {
owner = "precice";
repo = "fenics-adapter";
rev = "v${version}";
hash = "sha256-tddOcFZ/ls6fV+prtHQSIJmJ04eU9voj7ZyXEzEU6fA=";
};

nativeBuildInputs = [
Expand All @@ -33,10 +34,8 @@ python3.pkgs.buildPythonPackage rec {
fenics-mshr
python3.pkgs.scipy
];
checkInputs = with python3.pkgs; [ pytest ];

# TODO(conni2461): Remove once (two tests still fail
doCheck = false;
pythonImportsCheck = [ "fenicsprecice" ];
nativeCheckInputs = with python3.pkgs; [ pytest ];

DIJITSO_CACHE_DIR = "/tmp";

Expand Down
File renamed without changes.