Skip to content

Commit

Permalink
docs: fix more typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Mo-Gul committed Oct 20, 2024
1 parent 56b8571 commit 823f422
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/src/user_guide/basic_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ One can find out more about the information stored within these model objects in
**Extended Corresponding States ([`ECS`](@ref))**:
- SPUNG ([`SPUNG`](@ref))

One can find out more about each of these equations of state within our background documentation. Nevertheless, all of these equations are compatible with all methods availble in our package.
One can find out more about each of these equations of state within our background documentation. Nevertheless, all of these equations are compatible with all methods available in our package.

There a few optional arguments available for these equations which will be explained below. One of these is specifying the location of the parameter databases, the details of which can be found in our Custom databases documentation.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/user_guide/custom_dtb.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ model2 = PCSAFT(["your_species_1","your_species_2"];userlocations=["dtb_like","d

The rest works exactly as it normally would! We recommend reading the background documentation for the various models, as well as the [`getparams`](@ref) docs, to ensure the units of the parameters you provide are correct and how those parameters are parsed into each model.

You can create those parameters without leaving the julia REPL, by using [`Clapeyron.ParamTable`](@ref). this function will create a temporary location on where a CSV containing the table is created:
You can create those parameters without leaving the Julia REPL, by using [`Clapeyron.ParamTable`](@ref). this function will create a temporary location on where a CSV containing the table is created:

```julia
data = (species = ["water"],Mw = [18.0])
Expand Down
8 changes: 4 additions & 4 deletions docs/src/user_guide/custom_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,15 @@ end
# Those locations are relative to the default database location.
Clapeyron.default_locations(::Type{PCSAFT}) = ["PCSAFT_parameters/PCSAFT_like.csv","PCSAFT_parameters/PCSAFT_unlike.csv","PCSAFT_parameters/PCSAFT_assoc.csv"]

# Although optional, it's generally good practise to cite your models!
# Although optional, it's generally good practice to cite your models!
# We use DOI references in general.
Clapeyron.default_references(::Type{PCSAFT}) = ["10.1021/ie0003887", "10.1021/ie010954d"]

# Use this function if you need to perform any transformations, from the input parameters, to the final ones:
function Clapeyron.transform_params(::Type{PCSAFT},params)
# params is a Dict{String,ClapeyronParam}
sigma = params["sigma"]
# We reescale the sigma values
# We rescale the sigma values
sigma.values .*= 1e-10

# If k is not provided, it will be not be considered
Expand All @@ -126,7 +126,7 @@ function Clapeyron.transform_params(::Type{PCSAFT},params)
return params
end
```
The `@newmodel` macro, in conjunction with the functions defined above, gets lowered to the following julia code:
The `@newmodel` macro, in conjunction with the functions defined above, gets lowered to the following Julia code:

```Julia
struct PCSAFT{T<:IdealModel} <: PCSAFTModel
Expand Down Expand Up @@ -185,7 +185,7 @@ You can, of course, not use the macro, if your model depends itself on other mod

If we obey that convention, we may use the `@f` macro, which automatically substitutes the first four parameters for compactness. For example, `@f(func,i,j)` is equivalent to calling `func(model,V,T,z,i,j)`.

Clapeyron obtains all the properties of a model by differenciating the total helmoltz energy ([`eos`](@ref)) or the residual helmoltz energy ([`eos_res`](@ref)). `eos` and `eos_res` themselves are defined in terms of the reduced ideal helmholtz energy ([`a_res`](@ref)). In this case, we are going to define `a_res` for our own model:
Clapeyron obtains all the properties of a model by differentiating the total helmoltz energy ([`eos`](@ref)) or the residual helmoltz energy ([`eos_res`](@ref)). `eos` and `eos_res` themselves are defined in terms of the reduced ideal helmholtz energy ([`a_res`](@ref)). In this case, we are going to define `a_res` for our own model:

```julia
function Clapeyron.a_res(model::PCSAFTModel, V, T, z)
Expand Down

0 comments on commit 823f422

Please sign in to comment.