Giter Club home page Giter Club logo

psychrometrics_toolkit's Introduction

License: LGPL v3 Build status Build Status

Psychrometrics_Toolkit

The Psychrometrics_Toolkit allows for Psychrometrics calculations to be provided into the BHoM framework by wrapping the Psychrolib library.

Known Versions of Software Supported

  • PsychroLib.2.4.0

Documentation


This toolkit is part of the Buildings and Habitats object Model. Find out more on our wiki or at https://bhom.xyz

Quick Start ๐Ÿš€

Grab the latest installer and a selection of sample scripts.

Getting Started for Developers ๐Ÿค–

If you want to build the BHoM and the Toolkits from source, it's hopefully easy! ๐Ÿ˜„ Do take a look at our specific wiki pages here: Getting Started for Developers

Want to Contribute?

BHoM is an open-source project and would be nothing without its community. Take a look at our contributing guidelines and tips here.

Licence

BHoM is free software licenced under GNU Lesser General Public Licence - https://www.gnu.org/licenses/lgpl-3.0.html
Each contributor holds copyright over their respective contributions. The project versioning (Git) records all such contribution source information. See LICENSE and COPYRIGHT_HEADER.

psychrometrics_toolkit's People

Contributors

adecler avatar albinber avatar bhombot avatar dependabot[bot] avatar kprusicka avatar rasmuscanfjorden avatar tom-kingstone avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

ehtick

psychrometrics_toolkit's Issues

For Excel - could we make it clear what the output units are?

Description:

I understand that BHoM works in base SI units, but it would be great it we could make this clear in excel functions, especially where the more common units are kJ, kPa, etc for the specific metric.

e.g add J/kg to the end like so: "Calculates enthalpy from dry-bulb temperature and humidity ratio (J/kg)"
image

Combine compute methods to make computing certain values more user-friendly

Description:

Methods like DensityHumidityRatio, DensityRelativeHumidity and DensityWetBulbTemperature can be combined into a single method called Density, that has functionality to compute density from some given values. The Density method would take in these values and decide which calculation to do, then do the calculation and return the correct value. In the case where there is not enough information to compute, it will throw an error that accurately describes what is missing. If the user inputs more information and multiple methods can be used, it will select a method to use, and also output a message to the user that describes the inputs used to make the calculation.

Update AssemblyFileVersion

The AssemblyFileVersion attribute should now be updated to read 4.1.0.0 for all AssemblyInfo.cs files within this repository for the 4.1 milestone.

Creation of unit tests

Definition of the test :

It would be great to automate the testing of the Psychometrics Toolkit by creating the unit tests.

Update AssemblyFileVersion

The AssemblyFileVersion attribute should now be updated to read 4.2.0.0 for all AssemblyInfo.cs files within this repository for the 4.2 milestone.

Update AssemblyFileVersion

The AssemblyFileVersion attribute should now be updated to read 4.1.0.0 for all AssemblyInfo.cs files within this repository for the 4.1 milestone.

An error occurred on a unit test

The following errors have been reported on unit tests in this repository.

BHoM/Psychrometrics_Toolkit.ci\Datasets\Compute\PartialVapourPressure.json
Unit test set: PartialVapourPressure. Author: Karolina Prusicka
One or more of the UnitTests failed.
Inner results:
UnitTest: Method: PartialVapourPressure(Double dryBulbTemperature).
The UnitTest did not pass.
Inner results:
TestData: index: 0
Failed to run unit test. Errors given:
Failed to run with the given inputs

BHoM/Psychrometrics_Toolkit.ci\Datasets\Compute\TemperatureAtAltitude.json
Unit test set: TemperatureAtAltitude. Author: Karolina Prusicka
One or more of the UnitTests failed.
Inner results:
UnitTest: Method: TemperatureAtAltitude(Double altitude).
The UnitTest did not pass.
Inner results:
TestData: index: 0
Execution of the method did not return the expected outputs.
Inner results:
07/09/2023 04:20:37
Data returned for output 0 is different than expected.
Expected value: 15, returned value from execution: 288.15.

Unit tests for newest methods.

Definition of the test :

The three newest methods: FromHumidityRatio, FromRelativeHumidity and FromWetBulbTemperature require data driven unit tests to align with the other methods in the toolkit.

For input values:

  • Temperatures between 173.15 and 473.15
  • Humidity Ratios between 0 and 1
  • Relative Humidity between 0 and 100
  • Pressure between 0 and 200,000

These will be recorded with low confidence.

Notes :

  • At pressures below 8739 Pa, HumidityRatio cannot be 0, and RelativeHumidity cannot be below 100%

An error occurred on a unit test

The following errors have been reported on unit tests in this repository.

BHoM/Psychrometrics_Toolkit.ci\Datasets\Compute\PartialVapourPressure.json
Unit test set: PartialVapourPressure. Author: Karolina Prusicka
One or more of the UnitTests failed.
Inner results:
UnitTest: Method: PartialVapourPressure(Double dryBulbTemperature).
The UnitTest did not pass.
Inner results:
TestData: index: 0
Failed to run unit test. Errors given:
Failed to run with the given inputs

BHoM/Psychrometrics_Toolkit.ci\Datasets\Compute\TemperatureAtAltitude.json
Unit test set: TemperatureAtAltitude. Author: Karolina Prusicka
One or more of the UnitTests failed.
Inner results:
UnitTest: Method: TemperatureAtAltitude(Double altitude).
The UnitTest did not pass.
Inner results:
TestData: index: 0
Execution of the method did not return the expected outputs.
Inner results:
08/09/2023 04:12:24
Data returned for output 0 is different than expected.
Expected value: 15, returned value from execution: 288.15.

Update AssemblyFileVersion

The AssemblyFileVersion attribute should now be updated to read 3.3.0.0 for all AssemblyInfo.cs files within this repository for the start of the 3.3 milestone

Update AssemblyFileVersion

The AssemblyFileVersion attribute should now be updated to read 4.1.0.0 for all AssemblyInfo.cs files within this repository for the 4.1 milestone.

Update AssemblyFileVersion

The AssemblyFileVersion attribute should now be updated to read 4.0.0.0 for all AssemblyInfo.cs files within this repository for the 4.0 milestone.

The AssemblyVersion should also be updated to read 4.0.0.0 for all AssemblyInfo.cs files within this repository for the 4.0 series.

Update AssemblyFileVersion

The AssemblyFileVersion attribute should now be updated to read 4.1.0.0 for all AssemblyInfo.cs files within this repository for the 4.1 milestone.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.