Patch documentation (#919)

* Fix documentation * Fix documentation * Fix documentation * Add documentation * Fix documentation * Fix documentation * Add documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Fix documentation * Refactor code test * Refactor latex test * Rename variable * Fix documentation * Fix documentation * Split symbol into two * Remove duplicate law and test * Fix documentation * Fix documentation * Fix tests * Linter fixes --------- Co-authored-by: Andrey Lekar <[email protected]>
blackyblack · Nov 11, 2024 · 51ab2a0 · 51ab2a0
1 parent ed3ecab
commit 51ab2a0
Show file tree

Hide file tree

Showing 73 changed files with 952 additions and 1,381 deletions.
diff --git a/symplyphysics/definitions/boltzmann_factor_via_state_energy_and_temperature.py b/symplyphysics/definitions/boltzmann_factor_via_state_energy_and_temperature.py
@@ -13,19 +13,17 @@
 from sympy import Eq, exp
 from symplyphysics import (
     quantities,
-    dimensionless,
     Quantity,
     validate_input,
     validate_output,
     symbols,
     convert_to_float,
-    SymbolNew,
     clone_as_symbol,
 )
 
-boltzmann_factor = SymbolNew("f", dimensionless)
+boltzmann_factor = symbols.boltzmann_factor
 """
-Boltzmann factor.
+:symbols:`boltzmann_factor`.
 """
 
 energy_of_state = clone_as_symbol(symbols.energy, display_symbol="E[i]", display_latex="E_i")

diff --git a/symplyphysics/definitions/damped_harmonic_oscillator_equation.py b/symplyphysics/definitions/damped_harmonic_oscillator_equation.py
@@ -22,9 +22,14 @@
 :symbols:`time`.
 """
 
-displacement = clone_as_function(symbols.position, [time])
+displacement = clone_as_function(
+    symbols.euclidean_distance,
+    [time],
+    display_symbol="x",
+    display_latex="x",
+)
 """
-Displacement of the oscillating body as a function of time. See :symbols:`position`.
+Displacement of the oscillating body as a function of time. See :symbols:`euclidean_distance`.
 """
 
 undamped_angular_frequency = clone_as_symbol(symbols.angular_frequency, positive=True)
@@ -49,7 +54,7 @@
 
 
 @validate_input(
-    initial_position_=symbols.distance,
+    initial_position_=symbols.euclidean_distance,
     initial_velocity_=symbols.speed,
     undamped_angular_frequency_=undamped_angular_frequency,
     damping_ratio_=damping_ratio,

diff --git a/symplyphysics/laws/dynamics/period_of_physical_pendulum.py b/symplyphysics/laws/dynamics/period_of_physical_pendulum.py
@@ -45,9 +45,9 @@
 The :symbols:`rotational_inertia` of the pendulum.
 """
 
-distance_to_pivot = clone_as_symbol(symbols.distance, positive=True)
+distance_to_pivot = clone_as_symbol(symbols.euclidean_distance, positive=True)
 """
-The :symbols:`distance` between the pivot and the pendulum's center of mass.
+The :symbols:`euclidean_distance` between the pivot and the pendulum's center of mass.
 """
 
 law = Eq(

diff --git a/symplyphysics/laws/dynamics/potential_energy_from_deformation.py b/symplyphysics/laws/dynamics/potential_energy_from_deformation.py
@@ -30,9 +30,9 @@
 The spring's :symbols:`stiffness`, or spring constant.
 """
 
-displacement = symbols.distance
+displacement = symbols.euclidean_distance
 """
-The displacement of the spring, or the :symbols:`distance` between the initial position
+The displacement of the spring, or the :symbols:`euclidean_distance` between the initial position
 and the rest position.
 """
 

diff --git a/symplyphysics/laws/electricity/charge_is_quantized.py b/symplyphysics/laws/electricity/charge_is_quantized.py
@@ -11,8 +11,6 @@
 
 from sympy import Eq
 from symplyphysics import (
-    SymbolNew,
-    dimensionless,
     Quantity,
     validate_input,
     validate_output,
@@ -25,9 +23,9 @@
 Total :symbols:`charge` of the body.
 """
 
-integer_factor = SymbolNew("n", dimensionless)  # positive, zero or negative
+integer_factor = symbols.whole_number
 """
-Integer factor of any sign.
+:symbols:`whole_number`.
 """
 
 law = Eq(charge, integer_factor * quantities.elementary_charge)

diff --git a/symplyphysics/laws/electricity/circuits/capacitance_is_proportional_to_plate_area.py b/symplyphysics/laws/electricity/circuits/capacitance_is_proportional_to_plate_area.py
@@ -34,9 +34,9 @@
 :symbols:`area` of the plates.
 """
 
-distance = symbols.distance
+distance = symbols.euclidean_distance
 """
-:symbols:`distance` between the plates.
+:symbols:`euclidean_distance` between the plates.
 """
 
 law = Eq(capacitance, absolute_permittivity * area / distance)

diff --git a/...ricity/circuits/voltage_across_charging_capacitor_in_serial_resistor_capacitor_circuit.py b/...ricity/circuits/voltage_across_charging_capacitor_in_serial_resistor_capacitor_circuit.py
@@ -35,7 +35,7 @@
 :symbols:`voltage` across the capacitor.
 """
 
-source_voltage = clone_as_symbol(symbols.voltage, display_symbol="V_0", display_latex="V_0")
+source_voltage = clone_as_symbol(symbols.voltage, subscript="0")
 """
 :symbols:`voltage` of the source, which is the initial voltage across the resistor.
 """

diff --git a/symplyphysics/laws/electricity/electric_charge_is_constant_in_isolated_system.py b/symplyphysics/laws/electricity/electric_charge_is_constant_in_isolated_system.py
@@ -9,12 +9,12 @@
 from sympy import Eq, solve
 from symplyphysics import Quantity, validate_input, validate_output, symbols, clone_as_symbol
 
-initial_charge = clone_as_symbol(symbols.charge, display_symbol="q_0", display_latex="q_0")
+initial_charge = clone_as_symbol(symbols.charge, subscript="0")
 """
 Initial :symbols:`charge` of the system.
 """
 
-final_charge = clone_as_symbol(symbols.charge, display_symbol="q_1", display_latex="q_1")
+final_charge = clone_as_symbol(symbols.charge, subscript="1")
 """
 Final :symbols:`charge` of the system.
 """

diff --git a/symplyphysics/laws/electricity/electric_dipole_moment_is_charge_times_distance.py b/symplyphysics/laws/electricity/electric_dipole_moment_is_charge_times_distance.py
@@ -30,9 +30,9 @@
 Magnitude of one the two point :symbols:`charge`-s comprising the system.
 """
 
-distance = symbols.distance
+distance = symbols.euclidean_distance
 """
-:symbols:`distance` between point charges.
+:symbols:`euclidean_distance` between point charges.
 """
 
 law = Eq(electric_dipole_moment, charge * distance)

diff --git a/symplyphysics/laws/electricity/electric_field_due_to_dipole.py b/symplyphysics/laws/electricity/electric_field_due_to_dipole.py
@@ -40,9 +40,9 @@
 :symbols:`electric_dipole_moment`.
 """
 
-distance = symbols.distance
+distance = symbols.euclidean_distance
 """
-:symbols:`distance` to dipole.
+:symbols:`euclidean_distance` to dipole.
 """
 
 law = Eq(electric_field_strength,

diff --git a/symplyphysics/laws/electricity/electric_field_due_to_point_charge.py b/symplyphysics/laws/electricity/electric_field_due_to_point_charge.py
@@ -33,9 +33,9 @@
 Value of the point :symbols:`charge`.
 """
 
-distance = symbols.distance
+distance = symbols.euclidean_distance
 """
-:symbols:`distance` to the charge.
+:symbols:`euclidean_distance` to the charge.
 """
 
 law = Eq(electric_field_strength,

diff --git a/symplyphysics/laws/electricity/electric_field_is_force_over_test_charge.py b/symplyphysics/laws/electricity/electric_field_is_force_over_test_charge.py
@@ -27,7 +27,7 @@
 Projection of the electrostatic :symbols:`force` applied to the test charge.
 """
 
-test_charge = clone_as_symbol(symbols.charge, display_symbol="q_0", display_latex="q_0")
+test_charge = clone_as_symbol(symbols.charge, subscript="0")
 """
 Value of the test :symbols:`charge`.
 """

diff --git a/symplyphysics/laws/electricity/electric_field_outside_charged_sphere.py b/symplyphysics/laws/electricity/electric_field_outside_charged_sphere.py
@@ -34,9 +34,9 @@
 Total :symbols:`charge` of the sphere.
 """
 
-distance = symbols.distance
+distance = symbols.euclidean_distance
 """
-:symbols:`distance` to the center of the sphere.
+:symbols:`euclidean_distance` to the center of the sphere.
 """
 
 law = Eq(electric_field_strength, charge / (4 * pi * quantities.vacuum_permittivity * distance**2))

diff --git a/symplyphysics/laws/electricity/electromotive_force_induced_in_moving_contour.py b/symplyphysics/laws/electricity/electromotive_force_induced_in_moving_contour.py
@@ -10,30 +10,27 @@
 
 from sympy import (Eq, Derivative)
 from symplyphysics import (
-    dimensionless,
-    units,
     Quantity,
-    SymbolNew,
     validate_input,
     validate_output,
     symbols,
     clone_as_function,
 )
 from symplyphysics.core.geometry.line import two_point_function, Point2D
 
-electromotive_force = SymbolNew("E", units.voltage, display_latex="\\mathcal{E}")
+electromotive_force = symbols.electromotive_force
 r"""
-Electromotive force induced in the contour.
+:symbols:`electromotive_force` induced in the contour.
 """
 
-current_turn_count = SymbolNew("N", dimensionless)
+current_turn_count = symbols.positive_number
 """
-Number of turns the current makes around the contour.
+Number of turns the current makes around the contour. See :symbols:`positive_number`.
 """
 
-time = SymbolNew("t", units.time)
+time = symbols.time
 """
-Time.
+:symbols:`time`.
 """
 
 magnetic_flux = clone_as_function(symbols.magnetic_flux, [time])

diff --git a/symplyphysics/laws/electricity/electromotive_force_induced_in_sinusoidally_rotating_coil.py b/symplyphysics/laws/electricity/electromotive_force_induced_in_sinusoidally_rotating_coil.py