Merge pull request #187 from oemof/fix/setup

Fix/setup

.github/workflows/codeql.yml

@@ -0,0 +1,44 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches:
+      - dev
+      - master
+      - 'release/**'
+  pull_request:
+    branches: [ "dev" ]
+  schedule:
+    - cron: "23 2 * * 2"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ python ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"

.github/workflows/lint.yml

@@ -0,0 +1,38 @@
+name: Black
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+      - 'release/**'
+  pull_request:
+
+jobs:
+  run-linters:
+    name: Run linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - name: Install Python dependencies
+        run: pip install black flake8
+
+      - name: Run linters
+        uses: samuelmeuli/lint-action@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          # Enable linters
+          black: true
+          flake8: false
+          # Mark the following line true if you want linters to attempt to autocorrect your code
+          auto_fix: false
+          git_name: "Greene Lab Linter"
+          git_email: "[email protected]"

.github/workflows/packaging.yml

@@ -0,0 +1,40 @@
+name: packaging
+
+on:
+  # Make sure packaging process is not broken
+  push:
+    branches:
+      - master
+      - dev
+      - 'release/**'
+  pull_request:
+  # Make a package for release
+  release:
+    types: [published]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.9]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools setuptools_scm twine wheel build
+    - name: Create packages
+      run: python -m build .
+    - name: Run twine check
+      run: twine check dist/*
+    - uses: actions/upload-artifact@v4
+      with:
+        name: tox-gh-actions-dist
+        path: dist

.github/workflows/tox_checks.yml

@@ -0,0 +1,57 @@
+# NB: this name is used in the status badge
+name: tox checks
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+      - 'release/**'
+  pull_request:
+
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * 6"  # 5:00 UTC every Saturday
+
+jobs:
+  lint:
+    name: ${{ matrix.toxenv }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        toxenv:
+          - clean
+          - check
+          - docs
+
+    steps:
+      - name: Update package list
+        run: sudo apt update
+      - name: Install LaTeX
+        run: sudo apt install dvipng rubber texlive-latex-extra
+      - name: Git clone
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ env.default_python || '3.9' }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: "${{ env.default_python || '3.9' }}"
+
+      - name: Pip cache
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.toxenv }}-${{ hashFiles('tox.ini', 'setup.py') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-${{ matrix.toxenv }}-
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          python -m pip install -U setuptools wheel build
+          python -m pip install -U tox
+
+      - name: Run ${{ matrix.toxenv }}
+        run: python -m tox -e ${{ matrix.toxenv }}

.github/workflows/tox_pytests.yml

@@ -0,0 +1,44 @@
+name: tox pytests
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+      - 'release/**'
+  pull_request:
+
+  workflow_dispatch:
+  schedule:
+    - cron: "0 5 * * 6"  # 5:00 UTC every Saturday
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.9, "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install cbc
+      run: sudo apt install coinor-cbc
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox tox-gh-actions coverage coveralls
+    - name: Test with tox
+      run: tox
+
+    - name: Check test coverage
+      run: coverage report -m --fail-under=${{ matrix.vcs == 'bzr' && 84 || 85 }}
+
+    - name: Report to coveralls
+      run: coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_SERVICE_NAME: github

.gitignore

@@ -8,6 +8,8 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+.venv/
+.vscode/
 venv/
 build/
 develop-eggs/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 oemof developing group
+Copyright (c) oemof developing group
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/compression_heat_pumps_and_chillers.rst

@@ -12,7 +12,7 @@ _____
 This module was developed to provide COP calculations
 based on temperatures for energy system optimizations with oemof.solph.
 
-A time series of pre-calculated COPs can be used as input for a transformer
+A time series of pre-calculated COPs can be used as input for a Converter
 (an oemof.solph component) in an energy system optimization.
 Discover more possibilities to use this module with our examples:
 https://github.com/oemof/oemof-thermal/tree/dev/examples
@@ -166,7 +166,7 @@ Do NOT use this function to determine the input for `calc_cops()`!
 References
 __________
 
-.. [1] VDE ETG Energietechnik, VDE-Studie "Potenziale für Strom im Wärmemarkt bis 2050 - Wärmeversorgung in flexiblen Energieversorgungssystemen mit hohen Anteilen an erneuerbaren Energien". 2015. (http://www.energiedialog2050.de/BASE/DOWNLOADS/VDE_ST_ETG_Warmemarkt_RZ-web.pdf)
+.. [1] VDE ETG Energietechnik, VDE-Studie "Potenziale für Strom im Wärmemarkt bis 2050 - Wärmeversorgung in flexiblen Energieversorgungssystemen mit hohen Anteilen an erneuerbaren Energien". 2015.
 
 .. [2] C. Arpagaus, Hochtemperatur-Wärmepumpen - Marktübersicht, Stand der Technik und Anwendungsbeispiele. Berlin, Offenbach: VDE-Verlag, 2019.
 

docs/concentrating_solar_power.rst

@@ -16,8 +16,8 @@ system optimizations with oemof.solph.
 In
 https://github.com/oemof/oemof-thermal/tree/dev/examples
 you can find an example on how to use the modul to calculate a CSP power plant.
-A time series of pre-calculated heat flows can be used as input for a source
-(an oemof.solph component), and a transformer (an oemof.solph component) can be
+A time series of pre-calculated heat flows can be used as input for a Source
+(an oemof.solph component), and a Converter (an oemof.solph component) can be
 used to hold electrical power consumption and further thermal losses of the
 collector in an energy system optimization.
 In addition, you will find an example which compares this precalculation with
@@ -175,7 +175,7 @@ calculated with a fix efficiency.
 
 The results of this precalculation can be used in an oemof energy system model
 as output of a source component. To model the behaviour of a collector, it can be
-complemented with a transformer, which holds the electrical consumption of pumps
+complemented with a Converter, which holds the electrical consumption of pumps
 and peripheral heat losses (see the the example csp_plant_collector.py).
 
 ParabolicTroughCollector facade
@@ -193,7 +193,7 @@ class of the facade module for all parameters which have to be provided.
 
 See example_csp_facade.py for an application example. It models the same
 system as the csp_plant_example.py, but uses the ParabolicTroughCollector facade
-instead of separate source and transformer.
+instead of separate Source and Converter.
 
 
 .. code-block:: python