Skip to content

Commit 88d4b35

Browse files
committed
update README and installation instructions
1 parent 26aba3f commit 88d4b35

File tree

2 files changed

+46
-6
lines changed

2 files changed

+46
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,34 +42,53 @@ If you find any issues, feel free to contact us directly on the [Zulip Channel](
4242

4343
# Installing Clapeyron
4444

45-
The minimum supported version is Julia 1.6. To install Clapeyron, launch Julia with
45+
The minimum supported version is Julia 1.10. To install Clapeyron, launch Julia with
4646

47-
```
47+
```sh
4848
> julia
4949
```
5050

5151
Hit the ```]``` key to enter Pkg mode, then type
5252

53-
```
53+
```julia-repl
5454
Pkg> add Clapeyron
5555
```
56+
5657
Or to add the development version:
57-
```
58+
59+
```julia-repl
5860
Pkg> add https://github.com/ClapeyronThermo/Clapeyron.jl#master
5961
```
62+
6063
Exit Pkg mode by hitting backspace.
6164

6265
Now you may begin using functions from the Clapeyron library by entering the command
6366

64-
```
67+
```julia
6568
using Clapeyron
6669
```
6770

6871
To remove the package, hit the ```]``` key to enter Pkg mode, then type
6972

70-
```
73+
```julia-repl
7174
Pkg> rm Clapeyron
7275
```
76+
77+
## Installing Clapeyron in Python
78+
79+
Clapeyron.jl is also available in python via the [pyclapeyron](github.com/ClapeyronThermo/pyclapeyron) package.
80+
You can install `pyclapeyron` from PyPI via `pip` or `uv`:
81+
82+
```sh
83+
pip install pyclapeyron
84+
```
85+
86+
or
87+
88+
```sh
89+
uv add pyclapeyron
90+
```
91+
7392
# Citing Clapeyron
7493

7594
If you are using Clapeyron for your research work, please cite the following:

docs/src/installation.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ julia> using Pkg
3535
julia> Pkg.update("Clapeyron")
3636
```
3737

38+
If you want to use the development version, you need to install the `master` branch of the repository, in the following way:
39+
40+
```julia
41+
julia> Pkg.add(url="https://github.com/ClapeyronThermo/Clapeyron.jl", rev="master")
42+
```
43+
3844
## Recommended packages
3945

4046
In order to fully utilise Clapeyron, users may need certain features not included in the package.
@@ -44,3 +50,18 @@ Here is a list of packages the developers of Clapeyron recommend using:
4450
However, if users are more-familiar with matplotlib, [PyPlot.jl](https://github.com/JuliaPy/PyPlot.jl) is also available but is trickier to install.
4551
* Data storage and manipulation: The default packages in Julia are [DataFrames.jl](https://github.com/JuliaData/DataFrames.jl) and [Tables.jl](https://github.com/JuliaData/Tables.jl).
4652
Both of these make it easy to store values and then export them into various data types.
53+
54+
## Installing Clapeyron in Python
55+
56+
Clapeyron.jl is also available in python via the [pyclapeyron](github.com/ClapeyronThermo/pyclapeyron) package.
57+
You can install `pyclapeyron` from PyPI via `pip` or `uv`:
58+
59+
```
60+
pip install pyclapeyron
61+
```
62+
63+
or
64+
65+
```
66+
uv add pyclapeyron
67+
```

0 commit comments

Comments
 (0)