@@ -771,7 +771,7 @@ def fermi_dirac_distribution(
771771 ValueError: If `temperature < 0 K`.
772772
773773 Returns:
774- np.ndarray or ( np.ndarray, go.Figure) :
774+ np.ndarray or tuple[ np.ndarray, go.Figure] :
775775 Fermi-Dirac distribution function values, and optionally the Plotly figure if `plot=True`.
776776 """
777777
@@ -878,7 +878,7 @@ def calculate_internal_energies(
878878 resolution : float = 0.001 ,
879879 plot : bool = False ,
880880 plot_temperature : float = None ,
881- ) -> np .ndarray :
881+ ) -> np .ndarray | tuple [ np . ndarray , go . Figure , go . Figure ] :
882882 """
883883 Calculates the thermal electronic contribution to the internal energy for a given volume.
884884
@@ -897,7 +897,8 @@ def calculate_internal_energies(
897897 ValueError: If `plot_temperature` is not in `temperatures` when `plot=True`.
898898
899899 Returns:
900- np.ndarray: Internal energy values, in eV.
900+ np.ndarray or tuple[np.ndarray, go.Figure, go.Figure]: Internal energy values, in eV and
901+ optionally the Plotly figures if `plot=True`.
901902 """
902903
903904 # If there are negative temperatures, raise an error
@@ -994,7 +995,7 @@ def plot_internal_energy_integral(
994995 filtered_energies : np .ndarray ,
995996 integrand_2 : np .ndarray ,
996997 plot_temperature : float ,
997- ) -> go .Figure :
998+ ) -> tuple [ go .Figure , go . Figure ] :
998999 """
9991000 Plots the integrands versus energy of the internal energy equation.
10001001
@@ -1006,7 +1007,7 @@ def plot_internal_energy_integral(
10061007 plot_temperature (float): Temperature at which the integrand is plotted, in K.
10071008
10081009 Returns:
1009- go.Figure: Plotly figure object containing the integrand curves.
1010+ tuple[ go.Figure, go.Figure] : Plotly figure objects containing the integrand curves.
10101011 """
10111012
10121013 plot_temperature = float (plot_temperature )
@@ -1048,7 +1049,7 @@ def calculate_entropies(
10481049 resolution : float = 0.0001 ,
10491050 plot : bool = False ,
10501051 plot_temperature : float = None ,
1051- ) -> np .ndarray :
1052+ ) -> np .ndarray | tuple [ np . ndarray , go . Figure ] :
10521053 """
10531054 Calculates the thermal electronic contribution to the entropy for a given volume.
10541055
@@ -1067,7 +1068,8 @@ def calculate_entropies(
10671068 ValueError: If plot_temperature is not in `temperatures` when `plot=True`.
10681069
10691070 Returns:
1070- np.ndarray: Entropy values as a function of temperature, in eV/K.
1071+ np.ndarray | tuple[np.ndarray, go.Figure]: Entropy values as a function of temperature, in eV/K
1072+ and optionally the Plotly figure if `plot=True`.
10711073 """
10721074
10731075 # If there are negative temperatures, raise an error
@@ -1198,7 +1200,7 @@ def calculate_heat_capacities(
11981200 resolution : float = 0.0001 ,
11991201 plot = False ,
12001202 plot_temperature : float = None ,
1201- ) -> np .ndarray :
1203+ ) -> np .ndarray | tuple [ np . ndarray , go . Figure ] :
12021204 """
12031205 Calculates the thermal electronic contribution to the heat capacity for a given volume.
12041206
@@ -1217,7 +1219,8 @@ def calculate_heat_capacities(
12171219 ValueError: If plot_temperature is not in `temperatures` when `plot=True`.
12181220
12191221 Returns:
1220- np.ndarray: Heat capacity values in eV/K.
1222+ np.ndarray | tuple[np.ndarray, go.Figure]: Heat capacity values in eV/K
1223+ and optionally the Plotly figure if `plot=True`.
12211224 """
12221225
12231226 # If there are negative temperatures, raise an error
0 commit comments