Skip to content

Commit

Permalink
[software] Add data generation README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mbertuletti committed Sep 25, 2024
1 parent c1c52b6 commit 0dd4e35
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions software/data/README.md
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.

0 comments on commit 0dd4e35

Please sign in to comment.