Release v0.4.2

.github/workflows/pytest.yml

@@ -0,0 +1,33 @@
+# 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 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

CHANGELOG.md

@@ -1,12 +1,24 @@
 Release History
 ===============
 
-0.4.2 (dev)
+0.4.3 (dev)
 ------------------
 
-**|fixed|**     automated download of example applications via the `download_example` functions now includes previously missing .csv files
+0.4.2 (2023-11-09)
+------------------
+**|new|**       classes to plot and save RAMP simulation results for post-processing (#89)
+
+**|new|**       continuous integration setup (#94 and #96)
+
+**|new|**       first automated tests (#93)
+
+**|fixed|**     moved the randomization of daily preference from appliance to user level (#92)
+
+**|fixed|**     installation options have been debugged and the documentation updated accordingly (#76, #95)
+
+**|fixed|**     automated download of example applications via the `download_example` functions now includes previously missing .csv files (#69)
 
-0.4.1 (2023-10-XX)
+0.4.1 (2023-10-08)
 ------------------
 
 **|hotfix|**    added option `-o` to the terminal command line interface to enable the user to provide output path to save ramp results. This option is also accessible to python users using `ofname` argument of the `ramp/ramp_run.py::run_usecase` or the `ramp/post_process/post_process.py::export_series` functions. 

README.rst

@@ -11,7 +11,7 @@
     :target: https://rampdemand.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
 
-.. image:: https://github.com/RAMP-project/RAMP/blob/documentation/docs/source/_static/RAMP_logo_basic.png?raw=true
+.. image:: https://github.com/RAMP-project/RAMP/blob/main/docs/source/_static/RAMP_logo_basic.png?raw=true
    :width: 300
 
 
@@ -22,30 +22,33 @@ What is RAMP
 ============
 RAMP is an open-source software suite for the stochastic simulation of any user-driven energy demand time series based on few simple inputs.
 
-The project aims to provide synthetic data wherever metered data does not exist, such as when designing systems in remote areas. Check out the `documentation <https://rampdemand.readthedocs.io/en/latest/?badge=latest>`_ and learn more on the RAMP world from our `website <https://rampdemand.org>`_! 
+The project aims to provide synthetic data wherever metered data does not exist, such as when designing systems in remote areas. Check out the `documentation <https://rampdemand.readthedocs.io/en/latest/?badge=latest>`_ and learn more on the RAMP world from our `website <https://rampdemand.org>`_!
 
-.. image:: https://github.com/RAMP-project/RAMP/blob/master/docs/figures/Example_output.jpg?raw=true
+.. image:: https://github.com/RAMP-project/RAMP/blob/main/docs/figures/Example_output.jpg?raw=true
    :width: 600
 
 Recommended installation method
 ===============================
 
+RAMP has been successfully installed and used on macOS, Windows and Linux.
+
 The easiest way to make RAMP software working is to use the free conda package manager which can install the current and future RAMP
-depencies in an easy and user friendly way.
+dependencies in an easy and user friendly way.
 
 To get conda, `download and install "Anaconda Distribution" <https://www.anaconda.com/products/individual>`_, or `"miniconda" <https://docs.conda.io/en/latest/miniconda.html>`_ which is lighter.
 You can install RAMP using pip, conda or from source code.
 
 Installing through pip
 ----------------------
-1. To install the RAMP software, we suggest to create a new environment by running the following command in the anaconda prompt:
+1. To install the RAMP software, we suggest to create a new environment by running the following command in the *Anaconda prompt*:
 
 .. code-block:: python
 
    conda create -n ramp python=3.8
 
+
 2. If you create a new environment for RAMP, you'll need to activate it each time before using it, by writing
-the following line in the *Anaconda Prompt*
+the following line in the *Anaconda Prompt*:
 
 .. code-block:: python
 
@@ -58,50 +61,35 @@ the following line in the *Anaconda Prompt*
   pip install rampdemand
 
 
-Installing through source code
-------------------------------
-You can also install RAMP from the source code! To do so, you first need to download the source code first:
+Installing through the source code
+----------------------------------
+You can also install RAMP from the source code! To do so, you first need to download the source code, which can be done in two ways:
 
-1. you can use git to clone the repository using:
+* You can use git to clone the repository via:
 
 .. code-block:: bash
 
    git clone https://github.com/RAMP-project/RAMP.git
 
-2. you may download the source code directly from:
+* Or, you may download the source code directly from:
 
 `"RAMP GitHub Repository" <https://github.com/RAMP-project/RAMP>`_.
 
-In this case, the source code will be downloaded as a zip file, so you need the extract the files.
-
-After downloading the source code using any of abovementioned ways, you need to use your **anaconda prompt** to install the code.
-You can follow the first two steps mentioned in **Installing through pip**. Then you need to change the directory of the promt to the folder where the source code is saved (where you can find the *setup.py* file). To install the RAMP software use:
+In this second case, the source code will be downloaded as a zip file, so you'll need to extract the files.
 
-.. code-block:: bash
-
-   python setup.py
+After downloading the source code using any of abovementioned methods, you'll need to use your **anaconda prompt** to install it. There are two options again:
 
-Alternatively, you may use:
+* You may follow the first two steps mentioned in **Installing through pip**. Then, change the directory in the prompt to the folder where the source code is saved (where you can find the *setup.py* file). To install the RAMP software, you may then use:
 
 .. code-block:: bash
 
-   conda env create -f requirements.yml
+   python setup.py install
 
-Requirements
-============
-RAMP has been tested on macOS, Windows and Linux.
+* Alternatively, without taking any prior action, simply change the directory in the prompt to the folder where the source code is saved and then use:
 
-For running RAMP, you'll need a few packages:
-
-#. The Python programming language, version 3.6 or higher
-#. A number of Python adds-on packages:
-
-   * `Pandas  <https://pandas.pydata.org/>`_
-   * `Numpy  <https://numpy.org/>`_
-   * `Matplotlib  <https://matplotlib.org/>`_
-   * `Openpyxl  <https://openpyxl.readthedocs.io/en/stable/>`_
+.. code-block:: bash
 
-The requirements are specified in the `requirements.txt` file.
+   conda env create -f environment.yml
 
 Quick start
 ===========
@@ -110,7 +98,7 @@ There are different ways to build a model using RAMP! Here, we provide a first e
 Example python input files
 --------------------------
 Three different input files are provided as example representing three different categories of appliances that can be modelled with RAMP.
-To have a look to the python files, you can download them using the "download_example" function:
+To have a look to the python files, you can download them using the `download_example` function:
 
 .. code-block:: python
 
@@ -125,7 +113,7 @@ To have a look to the python files, you can download them using the "download_ex
    publication <https://doi.org/10.1016/j.energy.2019.04.097>`__.
 
 -  ``input_file_2.py``: shows how to model thermal loads, with the
-   example of a “shower” appliance. The peculiarity of thermal appiances
+   example of a “shower” appliance. The peculiarity of thermal appliances
    is that the nominal power can be provided as external input as a
    “csv” file (in this case, ``shower_P.csv``). For the example “shower”
    appliance, the varying nominal power accounts for the effect of
@@ -153,18 +141,17 @@ To have a look to the python files, you can download them using the "download_ex
 Spreadsheet input files
 -----------------------
 
-It is also possible to use spreadsheets as input files. To do so you
+It is also possible to use spreadsheets as input files. To do so, you
 need to run the ``ramp`` command with the option ``-i``:
 
 .. code-block:: bash
 
    ramp -i <path to .xlsx input file>
 
+
 .. note:: You can input several files, separated from each others by a single blank space
 
-If you already know
-how many profile you want to simulate you can indicate it with the
-``-n`` option:
+If you already know how many profile you want to simulate you can indicate it with the ``-n`` option:
 
 .. code-block:: bash
 
@@ -175,6 +162,7 @@ providing a ``.xlsx`` input file with the ``-i`` option, this will then
 be equivalent to running ``python ramp_run.py`` from the ``ramp`` folder
 without being prompted for the number of profile within the console.
 
+
 If you want to save ramp results to a custom file, you can provide it with the option `-o`
 
 .. code-block:: bash
@@ -191,13 +179,13 @@ Other options are documented in the help of `ramp`, which you access with the ``
 
 
 If you have existing python input files, you can convert them to
-spreadsheet. To do so, go to ``ramp`` folder and run
+spreadsheet. To do so, go to the ``\ramp`` folder and run
 
 .. code-block:: bash
 
    python ramp_convert_old_input_files.py -i <path to the input file you wish to convert>
 
-For other example of command lines options, such as setting date ranges, please visit `the dedicated section  <https://rampdemand.readthedocs.io/en/latest/examples/year_simulation/year_simulation.html#setting-date-range>`_ of the documentation.
+For other examples of command lines options, such as setting date ranges, please visit `the dedicated section  <https://rampdemand.readthedocs.io/en/latest/examples/year_simulation/year_simulation.html#setting-date-range>`_ of the documentation.
 
 Building a model with a python script
 -------------------------------------
@@ -236,7 +224,7 @@ The use time frames can be specified using the 'window' method for each applianc
     window_2 = [1320,1380], # from 10 PM to 11 PM
    )
 
-Now you can generate your **stochastic Profiles**:
+Now you can generate your **stochastic profiles**:
 
 .. code-block:: python
 
@@ -249,7 +237,7 @@ Now you can generate your **stochastic Profiles**:
 
 Contributing
 ============
-This project is open-source. Interested users are therefore invited to test, comment or contribute to the tool. Submitting issues is the best way to get in touch with the development team, which will address your comment, question, or development request in the best possible way. We are also looking for contributors to the main code, willing to contibute to its capabilities, computational-efficiency, formulation, etc.
+This project is open-source. Interested users are therefore invited to test, comment or contribute to the tool. Submitting issues is the best way to get in touch with the development team, which will address your comment, question, or development request in the best possible way. We are also looking for contributors to the main code, willing to contribute to its capabilities, computational-efficiency, formulation, etc.
 
 To contribute changes:
 
@@ -260,7 +248,7 @@ To contribute changes:
 #. Push the branch to GitHub
 #. On GitHub, create a new pull request from the feature branch
 
-When committing new changes, please also take care of checking code stability by means of the `qualitativte testing <https://github.com/RAMP-project/RAMP/blob/development/CONTRIBUTING.md>`_ functionality.
+When committing new changes, please also take care of checking code stability by means of the `qualitative testing <https://github.com/RAMP-project/RAMP/blob/development/CONTRIBUTING.md>`_ functionality.
 
 
 How to cite

docs/docs-requirements.txt

@@ -2,6 +2,7 @@ pandas >= 1.3.3
 numpy >= 1.21.2
 multiprocess
 tqdm
+plotly
 xlsxwriter <= 1.3.7
 matplotlib >= 3.3.4
 openpyxl >= 3.0.6