Skip to content
Michael Wetter edited this page Sep 1, 2023 · 14 revisions

To update the BuildingsPy python package, proceed as follows:

  1. In buildingspy/VERSION, update the version number in the section

    3.0.0

    For development versions, use 3.0.dev0

  2. Update the file buildingspy/CHANGES.txt, in particular, include the release date as

    BuildingsPy Changelog
    ---------------------
    
    Version 1.1.0, July 26, 2012 -- Release 1.1
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    - Added ...
  3. Commit and push the changes to the repository, and make sure the regression tests work without error by running

    export PYTHONPATH=`pwd`
    make unittest doctest
  4. Delete temporary files by running from BuildingsPy the commands

    export PYTHONPATH=`pwd`
    git clean -f -x -d
  5. Run the following commands (which runs regression tests, doc tests, generates the documentation and posts the files to pypi.

    make dist
    make upload-test  # This can be done once only, uploads to https://test.pypi.org
    make upload       # This can be done once only, uploads to https://www.pypi.org
    postBuildingsPyToWeb.sh
  6. Tag the version in git using

    git tag -a v1.4.0 -m "Tagged version 1.4.0"
    git push origin --tags
  7. Enter the release at https://github.com/lbl-srg/BuildingsPy/releases

  8. Update https://simulationresearch.lbl.gov/modelica/download.html

Clone this wiki locally