Skip to content

Commit 3bac93d

Browse files
committed
Add detailed installation instructions
1 parent 3d45ccd commit 3bac93d

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ makedocs(
99
modules = [ReactionMechanismSimulator],
1010
pages = [
1111
"Home" => "index.md",
12+
"Installation.md",
1213
"Input.md",
1314
"Simulating.md",
1415
"Analysis.md",

docs/src/Installation.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Install Julia
2+
RMS is written in Juila language. So before stepping any further, Julia needs to be installed. The download links can be found at [download Julia](https://julialang.org/downloads/). More instructions can be found from the [instruction page](https://julialang.org/downloads/platform/).
3+
4+
## Standard Installation
5+
With julia RMS can be installed with:
6+
7+
```
8+
using Pkg
9+
Pkg.add("ReactionMechanismSimulator")
10+
Pkg.build("ReactionMechanismSimulator")
11+
```
12+
13+
## Developer Installation
14+
Clone RMS to your machine in an appropriate location we will refer to as `RMS_PATH``:
15+
```
16+
git clone https://github.com/ReactionMechanismGenerator/ReactionMechanismSimulator.jl.git
17+
```
18+
then you can install with
19+
```
20+
import Pkg
21+
Pkg.develop(Pkg.PackageSpec(path=RMS_PATH))
22+
Pkg.build("ReactionMechanismSimulator")
23+
```
24+
25+
## Testing RMS
26+
Unit and functional tests for RMS can be run with:
27+
```
28+
import Pkg
29+
Pkg.test("ReactionMechanismSimulator")
30+
```
31+
32+
## pyrms
33+
We also provide a python wrapper for RMS, [pyrms](https://github.com/ReactionMechanismGenerator/pyrms). Installation instructions are available on its github page.
34+
35+
## Julia-Python Linking
36+
The above instructions will automatically handle Julia-Python linking. However, in some cases it can be useful to use python from a specific conda environment. For these cases we provide instructions to relink Julia to a different Anaconda Python environment where `PATH_TO_YOUR_ENV` is the path to the Anaconda environment and `PATH_TO_PYTHON` is the path to the associated Python executable:
37+
38+
```
39+
import Pkg
40+
Pkg.add("PyCall")
41+
ENV["CONDA_JL_HOME"] = PATH_TO_YOUR_ENV
42+
Pkg.build("Conda")
43+
ENV["PYTHON"] = PATH_TO_PYTHON
44+
Pkg.build("PyCall")
45+
```

0 commit comments

Comments
 (0)