Overall cleanup of paths to scripts depending on where the document is.

pull/2256/head
derekpierre 2020-09-17 15:24:30 -04:00
parent b0fe51b1ae
commit f207b69a20
4 changed files with 9 additions and 9 deletions

View File

@ -52,7 +52,7 @@ Download the Book Text
For your convenience we have provided a bash script to acquire the "Finnegan's Wake" text. However,
feel free to use any text of your choice, as long you you edit the demo code accordingly.
To run the script:
To run the script from the ``examples/finnegans_wake_demo`` directory:
.. code::
@ -61,8 +61,8 @@ Download the Book Text
Run the Demo
---------------
After acquiring a text file to re-encrypt, execute the demo by running:
After acquiring a text file to re-encrypt, execute the demo from the ``examples/finnegans_wake_demo`` by running:
.. code::
(nucypher)$ python3 finnegans-wake-demo.py
(nucypher)$ python finnegans-wake-demo.py

View File

@ -64,7 +64,7 @@ Run the Demo
------------
Assuming you already have ``nucypher`` installed with the ``demos`` extra,
running the Heartbeat demo only involves running a local fleet of federated Ursulas in the ``examples/`` directory,
running the Heartbeat demo involves running a local fleet of federated Ursulas in the ``examples/`` directory,
and executing the ``alicia.py`` and ``doctor.py`` scripts contained in the ``examples/heartbeat_demo`` directory.
First, run the local fleet of federated Ursulas in a separate terminal:

View File

@ -13,7 +13,7 @@ without revealing private keys to intermediary entities.
### Run a fleet of federated Ursulas
`python3 ../run_demo_ursula_fleet.py`
`python ../run_demo_ursula_fleet.py`
### Download the Book!
@ -21,4 +21,4 @@ without revealing private keys to intermediary entities.
### Run
`python3 finnegans-wake-demo.py`
`python finnegans-wake-demo.py`

View File

@ -32,7 +32,7 @@ Ensure that you already have `nucypher` installed.
Run a fleet of federated Ursulas in a separate terminal:
```sh
(nucypher)$ python examples/run_demo_ursula_fleet.py
(nucypher)$ python ../run_demo_ursula_fleet.py
```
This will create a local network of federated Ursulas that will be used by the demo for re-encryption of data.
@ -40,14 +40,14 @@ Subsequently, running the demo only involves running the `alicia.py` and `doctor
You should run `alicia.py` first:
```sh
(nucypher)$ python examples/heartbeat_demo/alicia.py
(nucypher)$ python alicia.py
```
This will create a temporal directory called `alicia-files` that contains the data for making Alicia persistent
(i.e., her private keys). Apart from that, it will also generate data and keys for the demo.
What's left is running the `doctor.py` script:
```sh
(nucypher)$ python examples/heartbeat_demo/doctor.py
(nucypher)$ python doctor.py
```
This script will read the data generated in the previous step and retrieve re-encrypted ciphertexts via the NuCypher
network. The result is printed in the console: