IdealGases.jl Documentation

IdealGases.jl is a tool for fast thermodynamic properties calculations for ideal gases. This assumes that the specifc heat of the gas/mixture is only a function of its temperature, i.e., $c_p(T)$ , $h(T)$, and $s(T,p)$ (note the entropy is a function of both pressure and temperature).

One of the important features of IdealGases.jl is the ability to represent a mixture of gases as a single composite_species.

Getting started

There are several workflows that are possible to use IdealGases.jl. We outline here the most common few.

Simple install

The easiest way to run IdealGases.jl would be to add the package using the julia package manager using the github repository.

You can do this by starting a Julia session and then activating the package manager by typing ] and then entering:

pkg> add "https://github.com/MIT-LAE/IdealGases.jl.git"

You can then import IdealGases as you would with any Julia package:

julia> using IdealGases

Local development

If you are going to develop the source code of IdealGases.jl you might benefit from a local clone of the git repository which can then fit into a workflow using Revise.jl for example.

Step 1: Clone the git repo locally

git clone https://github.com/MIT-LAE/IdealGases.jl.git

Step 2: cd to the folder where IdealGases is cloned

Step 3: Use Pkg to install/ develop the package

pkg> dev .

You should now be able to import IdealGases from within any Julia script in your base environment.

Tip

If you are using Revise.jl be sure to first import Revise before importing IdealGases

using Revise
using IdealGases