cluster_collections.ProtoCluster.load#

ProtoCluster.load(rmin, rmax, additional_args=None, **kwargs)[source]#

Loads a model.ClusterModel instance from this cluster_collections.ProtoCluster instance.

Parameters:

  • rmin (float) – The minimum radius of the generation regime. (kpc)

  • rmax (float) – The maximum radius of the generation regime. (kpc)

  • additional_args (dict, optional) – The additional_args argument allows the user to pass additional arguments into the initialization function. Generally, there should be no reason to specify this unless some alteration has been made to the underlying source code.

  • kwargs (dict, optional) –

    Additional key-word arguments to pass along to the initialization function.

    Note

    If kwargs contains a stellar_density key and corresponding profile, it will be overridden if the underlying cluster_collections.ProtoCluster instance also has a stellar density profile.