carmapy.Carma
=============

.. currentmodule:: carmapy

.. autoclass:: Carma

   
   
   
   .. rubric:: Methods

   .. autosummary::
      :signatures: short
   
      ~Carma.add_P
      ~Carma.add_T
      ~Carma.add_coag
      ~Carma.add_gas
      ~Carma.add_het_group
      ~Carma.add_hom_group
      ~Carma.add_kzz
      ~Carma.add_vertical_winds
      ~Carma.add_z
      ~Carma.calc_scale_height
      ~Carma.calculate_z
      ~Carma.extend_atmosphere
      ~Carma.read_results
      ~Carma.run
      ~Carma.set_atmospheric_parameters
      ~Carma.set_atmospheric_parameters_from_defaults
      ~Carma.set_cloud_boundary
      ~Carma.set_cloud_boundary_type
      ~Carma.set_gas_boundary
      ~Carma.set_gas_boundary_type
      ~Carma.set_nmr
      ~Carma.set_physical_params
      ~Carma.set_stepping
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~Carma.coags
      ~Carma.dt
      ~Carma.elems
      ~Carma.gases
      ~Carma.groups
      ~Carma.growth
      ~Carma.iappend
      ~Carma.is_2d
      ~Carma.kzz_levels
      ~Carma.log_metallicity
      ~Carma.n_tstep
      ~Carma.name
      ~Carma.NBIN
      ~Carma.NLONGITUDE
      ~Carma.nucs
      ~Carma.NZ
      ~Carma.output_gap
      ~Carma.P_centers
      ~Carma.P_levels
      ~Carma.r_planet
      ~Carma.restart
      ~Carma.surface_grav
      ~Carma.T_centers
      ~Carma.T_levels
      ~Carma.velocity_avg
      ~Carma.wt_mol
      ~Carma.z_centers
      ~Carma.z_levels
   
   



.. automethod:: Carma.add_P
.. automethod:: Carma.add_T
.. automethod:: Carma.add_coag
.. automethod:: Carma.add_gas
.. automethod:: Carma.add_het_group
.. automethod:: Carma.add_hom_group
.. automethod:: Carma.add_kzz
.. automethod:: Carma.add_vertical_winds
.. automethod:: Carma.add_z
.. automethod:: Carma.calc_scale_height
.. automethod:: Carma.calculate_z
.. automethod:: Carma.extend_atmosphere
.. automethod:: Carma.read_results
.. automethod:: Carma.run
.. automethod:: Carma.set_atmospheric_parameters
.. automethod:: Carma.set_atmospheric_parameters_from_defaults
.. automethod:: Carma.set_cloud_boundary
.. automethod:: Carma.set_cloud_boundary_type
.. automethod:: Carma.set_gas_boundary
.. automethod:: Carma.set_gas_boundary_type
.. automethod:: Carma.set_nmr
.. automethod:: Carma.set_physical_params
.. automethod:: Carma.set_stepping