-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #249 from ReactionMechanismGenerator/debugging_docs
Improve Documentation
- Loading branch information
Showing
5 changed files
with
101 additions
and
2,035 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Install Julia | ||
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/). | ||
|
||
## Standard Installation | ||
With julia RMS can be installed with: | ||
|
||
``` | ||
using Pkg | ||
Pkg.add("ReactionMechanismSimulator") | ||
Pkg.build("ReactionMechanismSimulator") | ||
``` | ||
|
||
## Developer Installation | ||
Clone RMS to your machine in an appropriate location we will refer to as `RMS_PATH``: | ||
``` | ||
git clone https://github.com/ReactionMechanismGenerator/ReactionMechanismSimulator.jl.git | ||
``` | ||
then you can install with | ||
``` | ||
import Pkg | ||
Pkg.develop(Pkg.PackageSpec(path=RMS_PATH)) | ||
Pkg.build("ReactionMechanismSimulator") | ||
``` | ||
|
||
## Testing RMS | ||
Unit and functional tests for RMS can be run with: | ||
``` | ||
import Pkg | ||
Pkg.test("ReactionMechanismSimulator") | ||
``` | ||
|
||
## pyrms | ||
We also provide a python wrapper for RMS, [pyrms](https://github.com/ReactionMechanismGenerator/pyrms). Installation instructions are available on its github page. | ||
|
||
## Julia-Python Linking | ||
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: | ||
|
||
``` | ||
import Pkg | ||
Pkg.add("PyCall") | ||
ENV["CONDA_JL_HOME"] = PATH_TO_YOUR_ENV | ||
Pkg.build("Conda") | ||
ENV["PYTHON"] = PATH_TO_PYTHON | ||
Pkg.build("PyCall") | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.