diff --git a/EXPERIMENT.md b/EXPERIMENT.md index 33cdd93..b5baeee 100644 --- a/EXPERIMENT.md +++ b/EXPERIMENT.md @@ -37,12 +37,19 @@ This guide explains how to use the interactive notebook to experiment with diffe This script will: - Automatically create a Python virtual environment - Install all required dependencies - - Launch Jupyter notebook with the experimentation interface - - Open your browser to the interactive notebook + - Automatically launch the Jupyter notebook with the experimentation interface in you browser + + If jupyter is running on a remote host, you can tunnel the port `8888` to load the notebook in your local browser: + + ```bash + ssh @ -L localhost:8888:localhost:8888 -Nv + ``` + + Open the URL having a unique token from server logs and load `lockdrop-calculations.ipynb` 3. **Use the Interactive Interface** - The notebook will open automatically in your browser. Execute it by clicking "Run All Cells" from `Run` tab in order to start experimenting with different participation scenarios. + Once the notebook has been opened in your browser, execute it by clicking "Run All Cells" from `Run` tab in order to start experimenting with different participation scenarios. ## Using the Interactive Interface diff --git a/README.md b/README.md index 312d727..d529e3c 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan - Set zenith-stack version to use: ```bash - ZENITH_STACK_VERSION=v0.2.10 + ZENITH_STACK_VERSION=v0.2.11 ``` Check [releases](https://git.vdb.to/LaconicNetwork/zenith-stack/releases) page for version history. @@ -120,7 +120,7 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan ZENITH_STACK_DIR=$(pwd)/zenith-stack # Checkout to the required version - cd zenith-stack + cd $ZENITH_STACK_DIR git checkout $ZENITH_STACK_VERSION ``` @@ -226,13 +226,13 @@ It allows flexible simulation parameters: **Bootstrap Validator Configuration** -- **Bootstrap validator data directory**: Absolute path to the parent directory where the bootstrap validator deployment will be created (use the same parent directory as set for Genesis Generator). +- **Bootstrap validator data directory**: Absolute path to the parent directory where the bootstrap validator deployment will be created (**use the same parent directory as set for Genesis Generator**). - **Validator display name (moniker)**: Human-readable validator name for the simulation (default: ZodNode). **Gentx Signer Configuration** -- **Gentx signer data directory**: Absolute path to the parent directory where gentx will be signed and the genesis file created (use the same parent directory as set for Genesis Generator). +- **Gentx signer data directory**: Absolute path to the parent directory where gentx will be signed and the genesis file created (**use the same parent directory as set for Genesis Generator**). ### View Configuration @@ -469,7 +469,7 @@ Now we can run the comprehensive test suite to validate that the zenithd node's ssh @ -L localhost:8888:localhost:8888 -Nv ``` - Open the URL from server logs and load `lockdrop-calculations-simulated.ipynb`. + Open the URL having a unique token from server logs and load `lockdrop-calculations-simulated.ipynb`. The notebook contains useful visualizations including allocation distributions, lock period analysis, and participant statistics. diff --git a/test-runs/README.md b/test-runs/README.md index 4e170ef..e671232 100644 --- a/test-runs/README.md +++ b/test-runs/README.md @@ -60,7 +60,7 @@ To reproduce the results from any one of the test runs, follow these steps to ru - Set zenith-stack version to use: ```bash - ZENITH_STACK_VERSION=v0.2.10 + ZENITH_STACK_VERSION=v0.2.11 ``` Check [releases](https://git.vdb.to/LaconicNetwork/zenith-stack/releases) page for version history. @@ -87,7 +87,7 @@ To reproduce the results from any one of the test runs, follow these steps to ru ZENITH_STACK_DIR=$(pwd)/zenith-stack # Checkout to the required version - cd zenith-stack + cd $ZENITH_STACK_DIR git checkout $ZENITH_STACK_VERSION ``` @@ -190,13 +190,13 @@ This interactive tool will guide you through configuring all the necessary varia **Bootstrap Validator Configuration** -- **Bootstrap validator data directory**: Absolute path to the parent directory where the bootstrap validator deployment will be created (use the same parent directory as set for Genesis Generator). +- **Bootstrap validator data directory**: Absolute path to the parent directory where the bootstrap validator deployment will be created (**use the same parent directory as set for Genesis Generator**). - **Validator display name (moniker)**: Human-readable validator name for the simulation (default: ZodNode). **Gentx Signer Configuration** -- **Gentx signer data directory**: Absolute path to the parent directory where gentx will be signed and the genesis file created (use the same parent directory as set for Genesis Generator). +- **Gentx signer data directory**: Absolute path to the parent directory where gentx will be signed and the genesis file created (**use the same parent directory as set for Genesis Generator**). ### View Configuration @@ -256,6 +256,9 @@ Copy the generated folder from your chosen test run to zenith-stack: # Navigate to the lockdrop-simulation repo directory cd $LOCKDROP_SIMULATION_DIR +# Remove any existing data from previous runs +rm -rf $ZENITH_STACK_DIR/generated + # Example for run1 cp -r ./test-runs/run1/generated $ZENITH_STACK_DIR/generated