Merge pull request #106 from RAMP-project/release/0.5.0

Release v0.5.0

.github/workflows/pytest.yml

@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: RAMP tests
+
+on:
+  push:
+    branches: [ "main", "development" ]
+  pull_request:
+    branches: [ "main", "development" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install black
+      run: |
+        python -m pip install --upgrade pip
+        pip install black
+    - name: Lint with black
+      run: |
+        black . --check
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install -r tests/requirements.txt
+    - name: Test with pytest
+      run: |
+        pytest tests/

.github/workflows/python-publish-pypi.yml

@@ -0,0 +1,35 @@
+name: Deploy to PyPi
+
+on: 
+  release:
+      types: [created]
+
+jobs:
+  build_and_deploy:
+    name: Build the release and deploy to test pypi
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Install main dependencies
+        run: |
+          python -m pip install --upgrade pip twine setuptools wheel
+      - name: build distribution
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: test install package
+        run: |
+          pip install -e .
+      - name: Publish distribution 📦 to  PyPI
+
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          password: ${{ secrets.RAMP_PYPI_PW }}
+          repository_url: https://upload.pypi.org/legacy/

.github/workflows/python-pypi-test.yml

@@ -0,0 +1,42 @@
+name: Deploy to Test PyPi
+
+on:
+  push:
+      branches:
+        - development
+        - main
+
+  pull_request:
+    branches:
+      - development
+      - main
+jobs:
+  build_and_deploy:
+    name: Build the release and deploy to test pypi
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Install main dependencies
+        run: |
+          python -m pip install --upgrade pip twine setuptools wheel
+      - name: build distribution
+        run: |
+          python setup.py sdist bdist_wheel
+      - name: test install package
+        run: |
+          pip install -e .
+      - name: Publish distribution 📦 to TestPyPI
+
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+          verbose: true
+          password: ${{ secrets.RAMP_TEST}}
+          repository-url: https://test.pypi.org/legacy/

.readthedocs.yml

@@ -3,6 +3,13 @@
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 # Required
 version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/source/conf.py
@@ -15,6 +22,5 @@ sphinx:
 #  - pdf
 # Optionally set the version of Python and requirements required to build your docs
 python:
-   version: 3.7
    install:
       - requirements: docs/docs-requirements.txt

AUTHORS

@@ -15,5 +15,11 @@ Mohammad Amin Tahavori, VITO <[email protected]>
 Sylvain Quoilin, Université de Liège <[email protected]>
 Nicolò Stevanato, Politecnico di Milano <[email protected]>
 Gokarna Dhungel, Reiner Lemoine Institut <[email protected]>
-Avia Linke, Reiner Lemoine Institut  <[email protected]>
+Avia Linke, Reiner Lemoine Institut <[email protected]>
 Katrin Lammers, Reiner Lemoine Institut <[email protected]>
+Claudia Sanchez Solis, Université de Liège <[email protected]>
+Sarah Eckhoff, Leibniz Universität Hannover <[email protected]>
+Maria C.G. Hart, Leibniz Universität Hannover <[email protected]>
+Francesco Sanvito, TU Delft <[email protected]>
+Gregory Ireland, Reiner Lemoine Institut <[email protected]>
+Sergio Balderrama, Universidad Mayor de San Simon <[email protected]>

CHANGELOG.md

@@ -1,9 +1,34 @@
 Release History
 ===============
 
-0.4.2 (dev)
+0.5.1 (dev)
+-----------
+
+0.5.0 (2023-12-06)
 ------------------
 
+**|fixed|**     jupyter notebooks are up to date with the UseCase class
+
+**|fixed|**     UseCase class usage is now documented
+
+**|changed|**   num_profile variable was changed to num_days
+
+**|changed|**   User class get assigned automatically to a default UseCase instance if not provided
+
+**|changed|**   Delete ramp.core.initialize and ramp.core.stochastic_process, move calc_peak_time_range inside UseCase method
+
+**|fixed|**     conversion of .py files into .xlsx is fixed
+
+**|fixed|**     using .py files is now possible in the command line as well as from IDE
+
+**|new|**       tests for example jupyter notebook (smoke test to see if the notebooks run through)
+
+**|new|**       continuous integration setup
+
+**|new|**       first automated tests
+
+**|fixed|**     installation options have been debugged and the documentation updated accordingly
+
 **|fixed|**     automated download of example applications via the `download_example` functions now includes previously missing .csv files
 
 0.4.1 (2023-10-XX)