diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d91ed86 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +venv +__pycache__ +generated +.ipynb_checkpoints diff --git a/README.md b/README.md index 04db938..5df79d6 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ The lockdrop simulation validates the Zenith Network's token distribution mechan ```bash # For example: - mkdir /home/$USER/stage1-lockdrop-simulation + mkdir -p /home/$USER/stage1-lockdrop-simulation ``` Make sure you are in ansible directory: @@ -167,12 +167,17 @@ Execute the Jupyter notebook to perform lockdrop allocation calculations and gen 1. **Create Virtual Environment and Install Dependencies** - Navigate to the lockdrop-simulation directory: + Clone lockdrop simulation directory: ```bash - cd /lockdrop-simulation + git clone git@git.vdb.to:LaconicNetwork/lockdrop-simulation.git + + # Navigate to lockdrop-simulation directory + cd lockdrop-simulation ``` + Checkout to the latest [release](https://git.vdb.to/LaconicNetwork/lockdrop-simulation/releases) + Create and activate a Python virtual environment: ```bash @@ -186,6 +191,12 @@ Execute the Jupyter notebook to perform lockdrop allocation calculations and gen pip install -r requirements.txt ``` + Configure path to the `generated` directory that was generated in `zenith-stack` repo in above steps: + + ```bash + export GENERATED_DIR="/generated" + ``` + 2. **Execute the Notebook** Run the notebook to generate allocation calculations: @@ -201,7 +212,7 @@ Execute the Jupyter notebook to perform lockdrop allocation calculations and gen 3. **View Notebook Results (Optional)** - To view the analysis on generated data, open the notebook in your browser: + To view the analysis on generated data, open the notebook in your browser at : ```bash jupyter notebook lockdrop-calculations-simulated.ipynb @@ -222,12 +233,6 @@ Run comprehensive tests to validate that the zenithd node's TGE allocations and export RPC_API_ENDPOINT="http://localhost:26657" ``` - Add path to the `generated` directory that was generated in `zenith-stack` repo in above steps: - - ```bash - export GENERATED_DIR="/generated" - ``` - 2. **Run All Tests** Navigate to the lockdrop-simulation directory (if not already there):