Skip to main content
Version: 1.5.0

Parameters

The Parameter field is mainly used for setting fields that the simulator needs and that can be adjusted by an optimizer. But that doesn't mean you shouldn't use them for simple simulations. It's good for future readiness to add these parameters to your simulation configuration since it then allows you to easily run optimizations using this simulation and gives you a good overview of which settings you tried to run a certain simulation with. These parameters can be accessed through the self.parameters field in the environment class.

Format​

nametype
typearray of
{
    name: string,
    value: float,
    optimizer: {
        optimize: boolean,
        range: array of float,
        isDigit: boolean
    }
}
requiredtrue

Example​

parameters:
  - name: "swapping_fees_ETH_1"
    value: 0.001
    optimizer:
      optimize: true
      range: [0.001, 0.01]
      isDigit: false