scml.std.world
==============

.. py:module:: scml.std.world


Attributes
----------

.. autoapisummary::

   scml.std.world.PLACEHOLDER_AGENT_PREFIX
   scml.std.world.STD_DEFAULT_PARAMS
   scml.std.world.STD_DEFAULT_PARAMS2024


Classes
-------

.. autoapisummary::

   scml.std.world.StdWorld
   scml.std.world.SCML2024StdWorld


Module Contents
---------------

.. py:data:: PLACEHOLDER_AGENT_PREFIX
   :value: 'PlaceHolder__'


.. py:data:: STD_DEFAULT_PARAMS

.. py:data:: STD_DEFAULT_PARAMS2024

.. py:class:: StdWorld(*args, horizon=STD_DEFAULT_PARAMS['horizon'], price_range_fraction=STD_DEFAULT_PARAMS['price_range_fraction'], price_multiplier=STD_DEFAULT_PARAMS['price_multiplier'], wide_price_range=STD_DEFAULT_PARAMS['wide_price_range'], one_time_per_negotiation=STD_DEFAULT_PARAMS['one_time_per_negotiation'], perishable=STD_DEFAULT_PARAMS['perishable'], quantity_multiplier=STD_DEFAULT_PARAMS['quantity_multiplier'], **kwargs)

   Bases: :py:obj:`scml.oneshot.world.SCMLBaseWorld`


   The world representing the base standard simulation (starting SCML 2024)


   .. py:method:: generate(*args, n_processes=STD_DEFAULT_PARAMS['n_processes'], disposal_cost=STD_DEFAULT_PARAMS['disposal_cost'], disposal_cost_dev=STD_DEFAULT_PARAMS['disposal_cost_dev'], storage_cost=STD_DEFAULT_PARAMS['storage_cost'], storage_cost_dev=STD_DEFAULT_PARAMS['storage_cost_dev'], perishable=STD_DEFAULT_PARAMS['perishable'], max_productivity=STD_DEFAULT_PARAMS['max_productivity'], max_supply=STD_DEFAULT_PARAMS['max_supply'], exogenous_supply_predictability=STD_DEFAULT_PARAMS['exogenous_supply_predictability'], exogenous_sales_predictability=STD_DEFAULT_PARAMS['exogenous_sales_predictability'], cap_exogenous_quantities=STD_DEFAULT_PARAMS['cap_exogenous_quantities'], **kwargs) -> dict[str, Any]
      :classmethod:


      Generates the configuration for a world

      Remarks:
          - This method just sets the defaults differently to create a std instead of a oneshot world.




.. py:class:: SCML2024StdWorld(*args, horizon=STD_DEFAULT_PARAMS['horizon'], price_range_fraction=STD_DEFAULT_PARAMS['price_range_fraction'], price_multiplier=STD_DEFAULT_PARAMS['price_multiplier'], wide_price_range=STD_DEFAULT_PARAMS['wide_price_range'], one_time_per_negotiation=STD_DEFAULT_PARAMS['one_time_per_negotiation'], perishable=STD_DEFAULT_PARAMS['perishable'], quantity_multiplier=STD_DEFAULT_PARAMS['quantity_multiplier'], **kwargs)

   Bases: :py:obj:`StdWorld`


   The SCML-standard simulation as used in [SCML 2024](https://scml.cs.brown.edu)