Updated Cerebro Documentation #1
Conversation
source/setup/setup.rst
Outdated
| Cerebro has a few core dependencies that need to be setup before it can be used. | ||
| We provide a Dockerfile that installs all the dependencies required by Cerebro. Running the Dockerfile will build SCALE-MAMBA and EMP-AGMPC. | ||
| * Create the Dockerfile and requirements.txt. | ||
| * Dockerfile |
There was a problem hiding this comment.
Instead of putting the Dockerfile in the documentation, you can create the file and commit it to the repository. See an example here: https://github.com/opaque-systems/opaque/blob/master/docker/Dockerfile.
source/setup/setup.rst
Outdated
| @@ -2,69 +2,104 @@ | |||
| Cerebro Setup | |||
| ************************* | |||
|
|
|||
| Cerebro has a few core dependencies that need to be setup before it can be used. | |||
| We provide a Dockerfile that installs all the dependencies required by Cerebro. Running the Dockerfile will build SCALE-MAMBA and EMP-AGMPC. | |||
There was a problem hiding this comment.
Maybe you can simply say "We provide a Dockerfile that installs Cerebro as well as its dependencies."
source/setup/setup.rst
Outdated
| The documentation fully detailing SCALE-MAMBA can be obtained by running ``make doc`` in the SCALE-MAMBA repository. | ||
|
|
||
| The following is copied from SCALE-MAMBA's current setup documentation. | ||
|
|
||
| Prerequisite Libraries: | ||
| ************************* | ||
| * gcc/g++, tested with version 7.2.1 | ||
| * MPIR (compiled with the -cxx flag) | ||
| * python 2.7.5 (ideally with gmpy2 installed) | ||
| * OpenSSL (tested with version 1.1.0) | ||
| * Crypto ++ (tested with version 7.0) |
There was a problem hiding this comment.
I don't think these should be commented out? Docker is one way to test out Cerebro, but we need to still provide an installation guide for people who want to install Cerebro from scratch.
| * Crypto ++ (tested with version 7.0) | ||
|
|
||
|
|
||
|
|
||
| Setup Steps for SCALE-MAMBA | ||
| ***************************** |
There was a problem hiding this comment.
For these setup instructions, it would be good to put the instructions in code blocks, instead of in text. This way, a user can just copy and paste the commands into shell and run them.
There was a problem hiding this comment.
Do you want text/explanations at all? I can remove the text section if you don't want it. I will add a section that has purely shell commands which will set everything up if copy pasted into the shell. Some commands might be a bit cryptic though.
|
|
||
|
|
||
| EMP-AGMPC | ||
| ################ | ||
| Prerequisite Libraries: |
…txt to cerebro repo
Directions rely on pull requests for forked copy of SCALE-MAMBA and emp-agmpc