Merge branch 'develop' into 'master'

v2.3.6

See merge request iek-3/shared-code/fine!339

.github/workflows/test.yml

@@ -21,13 +21,14 @@ on:
     # - cron: 0 0 * * 0
 
 jobs:
-  TestFineSingle:
-    name: Ex1 (${{ matrix.python-version }}, ${{ matrix.os }})
+  TestFineCondaForge:
+    name: TestFineCondaForge (${{ matrix.python-version }}, ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.10", "3.11", "3.12"]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -44,21 +45,22 @@ jobs:
         run: |
           ls
           echo "LS Done"
-          mamba install fine pytest
+          mamba install fine pytest python=${{ matrix.python-version }}
           echo "Installation done"
           conda list
           echo "libaries printed"
           echo "start pytest"
           pytest
           echo "Pytest done"
 
-  TestFineDevLocal:
-    name: Ex1 (${{ matrix.python-version }}, ${{ matrix.os }})
+  TestFinePip:
+    name: TestFinePip (${{ matrix.python-version }}, ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.10", "3.11", "3.12"]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -67,20 +69,21 @@ jobs:
           path: './fine'
       - uses: conda-incubator/setup-miniconda@v3
         with:
-          miniforge-version: latest
-          channels: conda-forge
-          activate-environment: test_env
+          python-version: ${{ matrix.python-version }}
+          miniforge-variant: Mambaforge
+          activate-environment: fine 
+          environment-file: fine/requirements_dev.yml
       - name: Run tests
         shell: pwsh
         run: |
           ls
           echo "LS Done"
           cd fine
-          mamba env create --name fine_env --yes --file requirements_dev.yml
-          conda run --name fine_env pip install . --no-deps
+          conda run pip install . --no-deps
           echo "Installation done"
-          conda list --name fine_env
+          conda run python -V
+          conda list fine
           echo "libaries printed"
           echo "start pytest"
-          conda run --name fine_env pytest
+          conda run pytest
           echo "Pytest done"

.gitignore

@@ -13,6 +13,7 @@ __pycache__/
 *.docs/build/
 .vscode/
 build/
+.venv/
 
 # file types to ignore
 *.pyc
@@ -21,4 +22,4 @@ build/
 *.lp
 *.glp
 *.mps
-.coverage
+.coverage

.gitlab-ci.yml

@@ -30,7 +30,7 @@ variables:
     policy: pull
   before_script:
     - micromamba install -n base -y --file=requirements_dev.yml
-    - python -m pip install .
+    - python -m pip install --no-deps .
   rules:
     # Switch from branch pipeline to merge pipeline once a merge request has
     # been created on the branch.
@@ -45,7 +45,7 @@ variables:
   stage: test
   image: jugit-registry.fz-juelich.de/iek-3/shared-code/fine/fine-dev:latest
   before_script:
-    - python -m pip install -e .
+    - python -m pip install --no-deps -e .
   rules:
     # Do not run for pushes to master or develop and for merge requests to master
     - if: $CI_COMMIT_BRANCH == "master"
@@ -85,7 +85,7 @@ variables:
     policy: pull
   before_script:
     - micromamba install -n base -y --file=requirements_dev.yml
-    - python -m pip install .
+    - python -m pip install --no-deps .
   rules:
     # Do not run for pushes to master or develop and for merge requests to master
     - if: $CI_COMMIT_BRANCH == "master"
@@ -114,6 +114,18 @@ variables:
 
 # Tests
 
+test-pypi:
+  stage: test
+  script:
+    - micromamba install -c conda-forge -n base -y python=3.10 glpk gdal
+    - python -m pip install .[develop]
+    - python -m pytest -n auto test/
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "master"'
+    - if: '$CI_COMMIT_BRANCH == "develop"'
+    - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "master"'
+    - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop"'
+
 test-code:
   extends: .test_template
   script:
@@ -154,7 +166,7 @@ test-notebooks:
     # cell executing durations. With 'nbval-lax', notebooks are only tested for
     # execution errors Cells tagged 'nbval-check-output' are checked for
     # consistent output Cells tagged 'nbval-skip' are skipped.
-    - python -m pytest --nbval-lax --nbval-current-env --durations=20 examples/
+    - python -m pytest -n auto --dist loadscope --nbval-lax --nbval-current-env --durations=20 examples/
   rules:
     # Run only for pushes to master or develop and for merge requests to master.
     - if: '$CI_COMMIT_BRANCH == "master"'
@@ -164,12 +176,12 @@ test-notebooks:
 test-notebooks-docker:
   extends: .test_docker_template
   script:
-    - python -m pytest --nbval-lax --nbval-current-env  --durations=20 examples/
+    - python -m pytest -n auto --dist loadscope --nbval-lax --nbval-current-env  --durations=20 examples/
 
 test-notebooks-docker-noupdate:
   extends: .test_docker_template_noupdate
   script:
-    - python -m pytest --nbval-lax --nbval-current-env  --durations=20 examples/
+    - python -m pytest -n auto --dist loadscope --nbval-lax --nbval-current-env  --durations=20 examples/
 
 test-codestyle:
   stage: test

CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# Code of Conduct - ETHOS.FINE
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologising to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behaviour include:
+
+* The use of sexualised language or imagery, and sexual attention or advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behaviour and will take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviours that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported to the community leaders responsible for enforcement at <[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
+[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
+[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
+and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

LICENSE.txt

@@ -1,10 +1,10 @@
 MIT License
 
-Copyright (C) 2016-2022 FZJ-IEK-3
+Copyright (C) 2016-2024 FZJ-IEK-3
 
-Active Developers: Theresa Groß, Leander Kotzur, Noah Pflugradt, Julian Belina, Toni Busch, Philipp Dunkel, Patrick Freitag, Thomas Grube, Heidi Heinrichs, Maximilian Hoffmann, Kevin Knosala, Felix Kullmann, Stefan Kraus, Jochen Linßen, Rachel Maier, Peter Markewitz, Lars Nolting, Shruthi Patil, Jan Priesmann, Stanley Risch, Julian Schönau, Bismark Singh, Andreas Smolenko, Peter Stenzel, Chloi Syranidou, Christoph Winkler, Michael Zier, Detlef Stolten
+Active Developers: Theresa Groß, Kevin Knosala, Noah Pflugradt, Johannes Behrens, Julian Belina, Arne Burdack, Toni Busch, Philipp Dunkel, David Franzmann, Patrick Freitag, Thomas Grube, Heidi Heinrichs, Maximilian Hoffmann, Jason Hu, Shitab Ishmam, Sebastian Kebrich, Felix Kullmann, Jochen Linßen, Rachel Maier, Shruthi Patil, Jan Priesmann, Julian Schönau, Maximilian Stargardt, Lovindu Wijesinghe, Christoph Winkler, Detlef Stolten
 
-Alumni: Robin Beer, Henrik Büsing, Dilara Caglayan, Timo Kannengießer, Martin Robinius, Johannes Thürauf, Lara Welder
+Alumni: Robin Beer, Henrik Büsing, Dilara Caglayan, Timo Kannengießer, Leander Kotzur, Stefan Kraus, Peter Markewitz, Lars Nolting,Stanley Risch, Martin Robinius, Bismark Singh, Andreas Smolenko, Peter Stenzel, Chloi Syranidou, Johannes Thürauf, Lara Welder, Michael Zier
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal