You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,36 +9,38 @@ folder while the build will be placed in a build folder. The build requires a py
9
9
in the requirements.txt. You need MATLAB version and python version or RAT software installed in your system.
10
10
11
11
```bash
12
-
conda create -n RAT python=3.9
13
-
conda activate RAT
14
-
pip install -r requirements.txt
12
+
conda create -n RAT python=3.9
13
+
conda activate RAT
14
+
pip install -r requirements.txt
15
15
```
16
16
17
17
You also must have `pandoc` installed to build the Python example Jupiter notebooks. See the installation instructions [here](https://pandoc.org/installing.html). If not previously installed system-wide, install [pandoc](https://pandoc.org/) using [conda](https://docs.conda.io/) as described in their [installation manual](https://pandoc.org/installing.html#conda-forge)
18
18
depending on [conda](https://docs.conda.io/) flavour you are using.
19
19
20
-
If you do not have RAT code on your machine, download the appropriate version of RAT from the GitHub [release](https://github.com/RascalSoftware/RAT/releases) page, and unzip the contents into a folder called API (This folder should be located within RAT-doc directory, alongside main `.github` folder). For example on a Linux machine, the nightly can be downloaded as shown:
20
+
If you do not have RAT code on your machine, download the appropriate version of RAT from the GitHub [release](https://github.com/RascalSoftware/RAT/releases) page, and unzip the contents into a folder called API (This folder should be located within RAT-doc directory, alongside the **source** folder and main `make.bat` file (see below)). For example on a Linux machine, the nightly can be downloaded as shown:
Where `path_to_rat_docs_folder` is the location where documentation is cloned or unpacked.
27
29
If RAT is already present, you may create symbolic link to the existing` RAT` directory, e.g.:
28
30
29
31
for Windows:
30
32
31
33
cd path_to_rat_docs_folder
32
-
mklink /j API path_to_matlap_rat_folder
34
+
mklink /j API path_to_matlab_rat_folder
33
35
34
36
for linux/macOS:
35
37
36
38
```bash
37
-
cd path_to_rat_docs_folder
38
-
ln -s path_to_matlap_rat_folder API
39
+
cd path_to_rat_docs_folder
40
+
ln -s path_to_matlab_rat_folder API
39
41
```
40
42
41
-
Where `path_to_rat_docs_folder` is the path to the RAT documentation repository and `path_to_matlap_rat_folder` is the path to the downloaded MATLAB RAT release
43
+
Where `path_to_rat_docs_folder` is the path to the RAT documentation repository and `path_to_matlab_rat_folder` is the path to the downloaded MATLAB RAT release
42
44
43
45
[Python RAT API](https://github.com/RascalSoftware/python-RAT) should be installed on the same python virtual environment created earlier. Build process adds modules necessary for generating python documentation to the python modules search path. Look at [Python RAT repository](https://github.com/RascalSoftware/python-RAT/blob/main/README.md) for more information on how to build python API.
0 commit comments