-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[software] Add data generation README.md
- Loading branch information
1 parent
c1c52b6
commit 0dd4e35
Showing
1 changed file
with
11 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Data Generation | ||
|
||
Data for mempool applications is generated with the `gendata_header.py` script. | ||
The `gendata_*.py` libaries contain the golden models for the applications under test. | ||
The application parameters are passed to the script by means of the `gendata_params.hjson` file. | ||
|
||
## To test a new application: | ||
If a new application requires to be tested with data generated from a reference golden model: | ||
- Add a new golden model to the existing libraries, or create a new one. | ||
- Add a golden model function call to the `gendata_header.py`. | ||
- Add a new item in the `gendata_params.hjson` to make function parameters configurable. |