.. _dipplanner_autodoc:

Source code documentation
=========================

.. _dipplanner_autodoc_dive:

dive
----

.. automodule:: dipplanner.dive
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_segment:

segment
-------

.. automodule:: dipplanner.segment
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_tank:

tank
----

.. automodule:: dipplanner.tank
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_model_buhlmann:

model: buhlmann
----------------

.. _dipplanner_autodoc_model_buhlmann_exceptions:

Exceptions
^^^^^^^^^^

.. automodule:: dipplanner.model.buhlmann.model_exceptions
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_model_buhlmann_compartment:

compartment
^^^^^^^^^^^

.. automodule:: dipplanner.model.buhlmann.compartment
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_model_buhlmann_gradient:

gradient
^^^^^^^^

.. automodule:: dipplanner.model.buhlmann.gradient
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_model_buhlmann_oxtox:

oxygen toxicity
^^^^^^^^^^^^^^^

.. automodule:: dipplanner.model.buhlmann.oxygen_toxicity
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_model_buhlmann_model:

model
^^^^^

.. automodule:: dipplanner.model.buhlmann.model
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_exceptions:

Exceptions
----------

.. automodule:: dipplanner.dipp_exception
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_model_tools:

tools
-----

.. automodule:: dipplanner.tools
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_main:

main
----

.. automodule:: dipplanner.main
   :members:
   :private-members:
   :special-members:
   :inherited-members:
   :member-order: bysource
   :exclude-members: __delattr__, __weakref__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __getitem__, __getslice__,  __subclasshook__, __repr__

.. _dipplanner_autodoc_settings:

settings
--------

.. automodule:: dipplanner.settings

.. autodata:: dipplanner.settings.FRESH_WATER_DENSITY
.. autodata:: dipplanner.settings.SEA_WATER_DENSITY
.. autodata:: dipplanner.settings.ABSOLUTE_MAX_PPO2
.. autodata:: dipplanner.settings.ABSOLUTE_MIN_PPO2
.. autodata:: dipplanner.settings.ABSOLUTE_MAX_TANK_PRESSURE
.. autodata:: dipplanner.settings.ABSOLUTE_MAX_TANK_SIZE
.. autodata:: dipplanner.settings.SURFACE_TEMP
.. autodata:: dipplanner.settings.HE_NARCOTIC_VALUE
.. autodata:: dipplanner.settings.N2_NARCOTIC_VALUE
.. autodata:: dipplanner.settings.O2_NARCOTIC_VALUE
.. autodata:: dipplanner.settings.AR_NARCOTIC_VALUE
.. autodata:: dipplanner.settings.STOP_DEPTH_INCREMENT
.. autodata:: dipplanner.settings.LAST_STOP_DEPTH
.. autodata:: dipplanner.settings.STOP_TIME_INCREMENT
.. autodata:: dipplanner.settings.FORCE_ALL_STOPS
.. autodata:: dipplanner.settings.AMBIANT_PRESSURE_SEA_LEVEL
.. autodata:: dipplanner.settings.METHOD_FOR_DEPTH_CALCULATION
.. autodata:: dipplanner.settings.TRAVEL_SWITCH
.. autodata:: dipplanner.settings.FLIGHT_ALTITUDE
.. autodata:: dipplanner.settings.TEMPLATE
.. autodata:: dipplanner.settings.DECO_MODEL
.. autodata:: dipplanner.settings.WATER_DENSITY
.. autodata:: dipplanner.settings.AMBIANT_PRESSURE_SURFACE
.. autodata:: dipplanner.settings.DEFAULT_MAX_PPO2
.. autodata:: dipplanner.settings.DEFAULT_MIN_PPO2
.. autodata:: dipplanner.settings.DEFAULT_MAX_END
.. autodata:: dipplanner.settings.DIVE_CONSUMPTION_RATE
.. autodata:: dipplanner.settings.DECO_CONSUMPTION_RATE
.. autodata:: dipplanner.settings.DESCENT_RATE
.. autodata:: dipplanner.settings.ASCENT_RATE
.. autodata:: dipplanner.settings.RUN_TIME
.. autodata:: dipplanner.settings.USE_OC_DECO
.. autodata:: dipplanner.settings.GF_LOW
.. autodata:: dipplanner.settings.GF_HIGH
.. autodata:: dipplanner.settings.MULTILEVEL_MODE
.. autodata:: dipplanner.settings.AUTOMATIC_TANK_REFILL