Add more help text

Author: achow101

README.md

@@ -23,6 +23,8 @@ However sometimes git does not like it when the repo is owned by a different use
 
     sudo sudo git config --global --add safe.directory <path/to/repo>
 
+Usage:
+
 ```
 usage: simulation.py [options]
 
@@ -45,11 +47,11 @@ options:
                         set a random seed for deterministically reproducing a previous test run
   --timeout-factor TIMEOUT_FACTOR
                         adjust test timeouts by a factor. Setting it to 0 disables all timeouts
-  --scenario SCENARIO
-  --label LABEL
-  --payments PAYMENTS
-  --feerates FEERATES
-  --ops OPS
+  --scenario SCENARIO   Path to scenario file consisting of lines of comma separated pairs of payments and feerates
+  --label LABEL         A label to give to this simulation to help identify its results
+  --payments PAYMENTS   Path to payments file consisting of one payment per line in BTC. Positive is a deposit into the test wallet, negative is a withdrawal from the test wallet.
+  --feerates FEERATES   Path to a feerates file consisting of one feerate per line in BTC/kvb
+  --ops OPS             Maximum number of deposits and withdrawal actions to do, default is all payments in the scenario or payments file
   --weights WEIGHTS [WEIGHTS ...]
                         Causes recipient output types to be chosen randomly with provided weights per address type. Weights must add to 100 and be provided in the following order: bech32m bech32 p2sh-segwit legacy
 ```

scripts/framework.py

@@ -70,6 +70,7 @@ def check_json_precision():
 
 
 class Simulation:
+    """Copied and modified from BitcoinTestFramework in Bitcoin Core's test/functional/test_framework/test_framework.py"""
     def __init__(self):
         self.chain: str = "regtest"
         self.setup_clean_chain: bool = True
@@ -149,21 +150,23 @@ def parse_args(self):
             help="adjust test timeouts by a factor. Setting it to 0 disables all timeouts",
         )
 
-        parser.add_argument("--scenario", default=None, action=ScenarioOptionsAction)
-        parser.add_argument("--label", default=None)
+        parser.add_argument("--scenario", default=None, action=ScenarioOptionsAction, help="Path to scenario file consisting of lines of comma separated pairs of payments and feerates")
+        parser.add_argument("--label", default=None, help="A label to give to this simulation to help identify its results")
         parser.add_argument(
             "--payments",
             default=None,
             required="--feerates" in sys.argv,
             action=PaymentsFeeratesOptionsAction,
+            help="Path to payments file consisting of one payment per line in BTC. Positive is a deposit into the test wallet, negative is a withdrawal from the test wallet."
         )
         parser.add_argument(
             "--feerates",
             default=None,
             required="--payments" in sys.argv,
             action=PaymentsFeeratesOptionsAction,
+            help="Path to a feerates file consisting of one feerate per line in BTC/kvb"
         )
-        parser.add_argument("--ops", type=int, default=None)
+        parser.add_argument("--ops", type=int, default=None, help="Maximum number of deposits and withdrawal actions to do, default is all payments in the scenario or payments file")
         parser.add_argument(
             "--weights",
             type=int,