Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leondavi authored Sep 2, 2023
1 parent b701ba5 commit 44e9d5d
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,21 @@ Recommended cmake version 3.26
Minimum erlang version otp 24
Minimum gcc/g++ version 8.4

On each machine that runs Nerlnet go through the following steps:
On every device that is a part of Nerlnet cluster the following steps should be taken:

1. Clone this repository with its subomdules ```git clone --recurse-submodules <link to this repo> NErlNet```
2. Run ```sudo ./NerlnetInstall.sh```
2.1 With argument -i script builds and installs Erlang, latest stable, and CMake.
2.2 After running NerlnetInstall.sh, NErlNet directory can be accessed
    via the following path: ```/usr/local/lib/nerlnet-lib```
3. Run ```./NerlnetBuild.sh```
4. Create json files of architecture, connection map and experiment flow.
2.1 With argument -i script builds and installs Erlang, latest stable, and CMake.
(validate that erlang is not installed before executing installation from source)
2.2 On successful installation, NErlNet directory is accessible
    via the following path: ```/usr/local/lib/nerlnet-lib```
4. Run ```./NerlnetBuild.sh```
5. Create json files of architecture, connection map and experiment flow.
json configuration files names must follow the convention of prefixes:
arch_<any>.json, conn_<any>.json, exp_<any>.json.
arch_\<name\>.json, conn_\<name\>.json, exp_\<name\>.json.
4. Run ```./NerlnetRun.sh``` to start Nerlnet.

Optional: Run ```./NerlnetGetData.sh``` to create or get default inputDataDir
4. Run ```./NerlnetRun.sh``` to start Nerlnet
Optional: Run ```./NerlnetGetData.sh``` to create or get default inputDataDir


## Python API and Jupyter (For UI Server):
Expand Down

0 comments on commit 44e9d5d

Please sign in to comment.