Add documentation (#892)

* Patch documentation * Add documentation * Add documentation * Fix notation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Rename files * Add documentation * Add documentation * Add documentation * Add documentation * Fix documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Fix documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Fix documentation * Fix documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation * Add documentation and rename * Rename * Add documentation * Patch attributes * Patch attributes * Fix documentation * Fix inits * Fix documentation * Move directory
blackyblack · Aug 17, 2024 · 635a5b5 · 635a5b5
1 parent 50ad52d
commit 635a5b5
Show file tree

Hide file tree

Showing 98 changed files with 1,586 additions and 546 deletions.
diff --git a/...modynamics/maxwell_juettner_statistics/lorentz_factor_distribution_varying_temperature.py b/...modynamics/maxwell_juettner_statistics/lorentz_factor_distribution_varying_temperature.py
@@ -27,7 +27,7 @@
 rhs = rhs.subs({
     units.boltzmann_constant: convert_to_si(units.boltzmann_constant),
     units.speed_of_light: convert_to_si(units.speed_of_light),
-    reduced_law.mass: convert_to_si(units.electron_rest_mass)
+    reduced_law.particle_mass: convert_to_si(units.electron_rest_mass)
 })
 
 temperatures_ = [1e10, 2e10, 5e10]  # K

diff --git a/symplyphysics/laws/astronomy/__init__.py b/symplyphysics/laws/astronomy/__init__.py
@@ -1,6 +1,6 @@
 """
 Astronomy
-===============
+=========
 
 Astronomy is a natural science that studies celestial objects and the phenomena that occur in the cosmos.
 """
diff --git a/symplyphysics/laws/astronomy/relativistic/__init__.py b/symplyphysics/laws/astronomy/relativistic/__init__.py
@@ -1,6 +1,6 @@
 """
-Astronomy (Relativistic)
-========================
+**Astronomy (Relativistic)**
+============================
 
-Relativistic extension of astronomy.
+Collection of laws related to relativistic description of astronomy.
 """
diff --git a/symplyphysics/laws/chemistry/__init__.py b/symplyphysics/laws/chemistry/__init__.py
@@ -0,0 +1,8 @@
+"""
+Chemistry
+=========
+
+Chemistry is a physical science that studies the chemical elements that make up matter and
+compounds made of atoms, molecules and ions: their composition, structure, properties,
+behavior and the changes they undergo during reactions with other substances.
+"""
diff --git a/symplyphysics/laws/chemistry/electrochemistry/__init__.py b/symplyphysics/laws/chemistry/electrochemistry/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Electrochemistry**
+================================
+
+Collection of laws related to electromagnetical description of chemical laws.
+"""
diff --git a/...equivalent_from_molar_mass_and_valence.py → ...equivalent_from_molar_mass_and_valence.py b/...equivalent_from_molar_mass_and_valence.py → ...equivalent_from_molar_mass_and_valence.py
diff --git a/...ergy_of_an_electron_in_a_hydrogen_atom.py → ...ergy_of_an_electron_in_a_hydrogen_atom.py b/...ergy_of_an_electron_in_a_hydrogen_atom.py → ...ergy_of_an_electron_in_a_hydrogen_atom.py
diff --git a/...f_the_substance_deposited_on_electrode.py → ...f_the_substance_deposited_on_electrode.py b/...f_the_substance_deposited_on_electrode.py → ...f_the_substance_deposited_on_electrode.py
diff --git a/symplyphysics/laws/chemistry/potential_energy_models/__init__.py b/symplyphysics/laws/chemistry/potential_energy_models/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Potential energy models**
+===========================
+
+Different models of the potential energy have been devised to model particles in statistical
+theories of fluids and solids.
+"""
diff --git a/symplyphysics/laws/condensed_matter/__init__.py b/symplyphysics/laws/condensed_matter/__init__.py
@@ -0,0 +1,8 @@
+"""
+Condensed matter
+================
+
+Condensed matter physics is the field of physics that deals with the macroscopic and
+microscopic physical properties of matter, especially the solid and liquid phases,
+that arise from electromagnetic forces between atoms and electrons.
+"""
diff --git a/symplyphysics/laws/conservation/__init__.py b/symplyphysics/laws/conservation/__init__.py
@@ -0,0 +1,7 @@
+"""
+Conservation
+============
+
+A conservation law states that a particular measurable property of an isolated physical
+system does not change as the system evolves over time.
+"""
diff --git a/symplyphysics/laws/dynamics/damped_oscillations/__init__.py b/symplyphysics/laws/dynamics/damped_oscillations/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Damped oscillations (Dynamics)**
+==================================
+
+*Damping* is the loss of energy of an oscillating system by dissipation. It is an influence within or
+upon an oscillatory system that has the effect of reducing or preventing its oscillation.
+"""
diff --git a/symplyphysics/laws/dynamics/deformation/__init__.py b/symplyphysics/laws/dynamics/deformation/__init__.py
@@ -1,6 +1,6 @@
 """
-Dynamics (Deformation)
-=================================================
+**Deformation (Dynamics)**
+==========================
 
 In physics and continuum mechanics, deformation is the change in the shape or size of an object.
 """
diff --git a/symplyphysics/laws/dynamics/fields/__init__.py b/symplyphysics/laws/dynamics/fields/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Fields (Dynamics)**
+=====================
+
+A field is a physical quantity that has a value for each point in space and time. Using fields
+as a mathematical model allows us to correctly describe physical phenomena.
+"""
diff --git a/symplyphysics/laws/dynamics/springs/__init__.py b/symplyphysics/laws/dynamics/springs/__init__.py
@@ -0,0 +1,8 @@
+"""
+**Springs**
+===========
+
+A *spring* is a device consisting of an elastic but largely rigid material bent or molded into a form
+that can return into shape after being compressed or extended. When compressed, springs can store
+energy.
+"""
diff --git a/symplyphysics/laws/dynamics/springs/vector/__init__.py b/symplyphysics/laws/dynamics/springs/vector/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Springs (Vector)**
+====================
+
+Collection of laws related to vectorial description of springs.
+"""
diff --git a/symplyphysics/laws/dynamics/vector/__init__.py b/symplyphysics/laws/dynamics/vector/__init__.py
@@ -1,6 +1,6 @@
 """
-Dynamics (Vector)
-=================
+**Dynamics (Vector)**
+=====================
 
 Vector subset of dynamics laws
 """
diff --git a/symplyphysics/laws/electricity/__init__.py b/symplyphysics/laws/electricity/__init__.py
@@ -0,0 +1,8 @@
+"""
+Electromagnetism
+================
+
+*Electromagnetism* is a fundamental interaction that occurs between particles with electric
+charge via electromagnetic fields. Electromagnetism can be thought of as a combination of
+electrostatics and magnetism, which are distinct but closely intertwined phenomena.
+"""
diff --git a/symplyphysics/laws/electricity/chemistry/__init__.py b/symplyphysics/laws/electricity/chemistry/__init__.py
diff --git a/symplyphysics/laws/electricity/circuits/__init__.py b/symplyphysics/laws/electricity/circuits/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Circuits**
+============
+
+An *electrical circuit* is an interconnection of electrical components consisting of
+a closed loop, giving a return path for the current.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/couplers/__init__.py b/symplyphysics/laws/electricity/circuits/couplers/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Couplers**
+=======================
+
+*Coupling* refers to the transfer of a signal from one medium or circuit block to another.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/diodes/__init__.py b/symplyphysics/laws/electricity/circuits/diodes/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Diodes**
+=====================
+
+A *diode* is a two-terminal electronic component that conducts current primarily in one direction.
+This directory also contains laws for triodes, tetrodes, pentodes, etc.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/filters/__init__.py b/symplyphysics/laws/electricity/circuits/filters/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Filters**
+======================
+
+A *filter* is a device or process that removes some unwanted components or features from a signal.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/resonators/__init__.py b/symplyphysics/laws/electricity/circuits/resonators/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Resonators**
+=========================
+
+A *resonator* is an electronic component that can generate a resonant frequency.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/transmission_lines/__init__.py b/symplyphysics/laws/electricity/circuits/transmission_lines/__init__.py
@@ -0,0 +1,8 @@
+"""
+**Transmission lines**
+======================
+
+A *transmission line* is a specialized cable or other structure designed to conduct
+electromagnetic waves in a contained manner. The term applies when the conductors
+are long enough that the wave nature of the transmission must be taken into account.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/transmission_lines/coplanar_lines/__init__.py b/symplyphysics/laws/electricity/circuits/transmission_lines/coplanar_lines/__init__.py
@@ -0,0 +1,8 @@
+"""
+**Coplanar lines**
+==================
+
+A *coplanar* transmission line is a type of transmission line where the signal strip and
+ground planes are all located on the same side of the substrate. It is commonly used in
+microwave devices and MMICs due to its better isolation compared to microstrip lines.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/transmission_lines/microstrip_lines/__init__.py b/symplyphysics/laws/electricity/circuits/transmission_lines/microstrip_lines/__init__.py
@@ -0,0 +1,8 @@
+"""
+**Microstrip lines**
+====================
+
+*Microstrip* is a type of electrical transmission line which can be fabricated with
+any technology where a conductor is separated from a ground plane by a dielectric
+layer known as "substrate". Microstrip lines are used to convey microwave-frequency signals.
+"""
diff --git a/symplyphysics/laws/electricity/circuits/waveguides/__init__.py b/symplyphysics/laws/electricity/circuits/waveguides/__init__.py
@@ -0,0 +1,9 @@
+"""
+**Waveguides*
+=========================
+
+A *waveguide* is a structure that guides waves by restricting the transmission of energy
+to one direction. Common types of waveguides include acoustic waveguides which direct
+sound, optical waveguides which direct light, and radio-frequency waveguides which direct
+electromagnetic waves other than light like radio waves.
+"""
diff --git a/symplyphysics/laws/electricity/couplers/__init__.py b/symplyphysics/laws/electricity/couplers/__init__.py
diff --git a/symplyphysics/laws/electricity/maxwell_equations/__init__.py b/symplyphysics/laws/electricity/maxwell_equations/__init__.py
@@ -0,0 +1,9 @@
+"""
+**Maxwell equations**
+=====================
+
+**Maxwell's equations** describe how electric charges and electric currents create electric
+and magnetic fields. They are a set of coupled partial differential equations that, together
+with the Lorentz force law, form the foundation of classical electromagnetism, classical
+optics, electric and magnetic circuits.
+"""
diff --git a/symplyphysics/laws/electricity/resonators/__init__.py b/symplyphysics/laws/electricity/resonators/__init__.py
diff --git a/symplyphysics/laws/electricity/transmission_lines/__init__.py b/symplyphysics/laws/electricity/transmission_lines/__init__.py
diff --git a/symplyphysics/laws/electricity/transmission_lines/coplanar_lines/__init__.py b/symplyphysics/laws/electricity/transmission_lines/coplanar_lines/__init__.py
diff --git a/symplyphysics/laws/electricity/transmission_lines/microstrip_lines/__init__.py b/symplyphysics/laws/electricity/transmission_lines/microstrip_lines/__init__.py
diff --git a/symplyphysics/laws/electricity/vector/__init__.py b/symplyphysics/laws/electricity/vector/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Electromagnetism (Vector)**
+=============================
+
+Collection of laws related to vectorial description of electromagnetism.
+"""
diff --git a/symplyphysics/laws/electricity/waveguides/__init__.py b/symplyphysics/laws/electricity/waveguides/__init__.py
diff --git a/symplyphysics/laws/fields/__init__.py b/symplyphysics/laws/fields/__init__.py
@@ -0,0 +1,7 @@
+"""
+Fields
+======
+
+A field is a physical quantity that has a value for each point in space and time. Using fields
+as a mathematical model allows us to correctly describe physical phenomena.
+"""
diff --git a/symplyphysics/laws/geometry/__init__.py b/symplyphysics/laws/geometry/__init__.py
@@ -0,0 +1,6 @@
+"""
+Geometry
+========
+
+A collection of geometry relations commonly used in physics.
+"""
diff --git a/symplyphysics/laws/geometry/vector/__init__.py b/symplyphysics/laws/geometry/vector/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Geometry (Vector)**
+=====================
+
+A collection of laws related to vectorial description of geometry relations.
+"""
diff --git a/symplyphysics/laws/gravity/radial_motion/__init__.py b/symplyphysics/laws/gravity/radial_motion/__init__.py
@@ -1,6 +1,6 @@
 """
-Radial motion
-=============
+**Radial motion**
+=================
 
 Many properties regarding the movement of planets in the gravitational field of the star
 can be found by studing the energy equation of the radial motion of the planet.

diff --git a/symplyphysics/laws/gravity/vector/__init__.py b/symplyphysics/laws/gravity/vector/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Gravity (Vector)**
+====================
+
+A collection of laws related to a vectorial description of gravity.
+"""
diff --git a/symplyphysics/laws/hydro/__init__.py b/symplyphysics/laws/hydro/__init__.py
@@ -0,0 +1,7 @@
+"""
+Fluid mechanics
+===============
+
+Fluid mechanics is the branch of physics concerned with the mechanics of fluids
+(liquids, gases, and plasmas) and the forces on them.
+"""
diff --git a/symplyphysics/laws/kinematic/__init__.py b/symplyphysics/laws/kinematic/__init__.py
@@ -1,6 +1,7 @@
 """
-Kinematic
-=========
+Kinematics
+==========
 
-Kinematics describes the motion of points, bodies (objects), and systems of bodies (groups of objects) without considering the forces that cause them to move.
+*Kinematics* describes the motion of points, bodies (objects), and systems of bodies
+(groups of objects) without considering the forces that cause them to move.
 """
diff --git a/symplyphysics/laws/kinematic/damped_oscillations/__init__.py b/symplyphysics/laws/kinematic/damped_oscillations/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Damped oscillations (Kinematics)**
+====================================
+
+*Damping* is the loss of energy of an oscillating system by dissipation. It is an influence within or
+upon an oscillatory system that has the effect of reducing or preventing its oscillation.
+"""
diff --git a/symplyphysics/laws/kinematic/rotational_inertia/__init__.py b/symplyphysics/laws/kinematic/rotational_inertia/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Rotational inertia (Kinematics)**
+===================================
+
+Rotational inertia is a quantity that determines the torque needed for a desired angular
+acceleration about a rotational axis.
+"""
diff --git a/symplyphysics/laws/kinematic/rotational_inertia/geometries/__init__.py b/symplyphysics/laws/kinematic/rotational_inertia/geometries/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Geometries (Rotational inertia)**
+===================================
+
+Formulas of rotational inertia can be pre-calculated for bodies of certain shapes.
+"""
diff --git a/symplyphysics/laws/kinematic/vector/__init__.py b/symplyphysics/laws/kinematic/vector/__init__.py
@@ -1,6 +1,6 @@
 """
-Kinematic (vector)
-==================
+**Kinematics (Vector)**
+=======================
 
 Vector subset of kinematic laws.
 """
diff --git a/symplyphysics/laws/nuclear/__init__.py b/symplyphysics/laws/nuclear/__init__.py
@@ -0,0 +1,7 @@
+"""
+Nuclear physics
+===============
+
+*Nuclear physics* is the field of physics that studies atomic nuclei and their constituents
+and interactions, in addition to the study of other forms of nuclear matter.
+"""
diff --git a/symplyphysics/laws/nuclear/buckling/__init__.py b/symplyphysics/laws/nuclear/buckling/__init__.py
@@ -0,0 +1,7 @@
+"""
+**Buckling (Nuclear physics)**
+==============================
+
+*Geometric buckling* is a measure of neutron leakage and *material buckling* is a measure
+of the difference between neutron production and neutron absorption.
+"""
diff --git a/symplyphysics/laws/optics/__init__.py b/symplyphysics/laws/optics/__init__.py
@@ -0,0 +1,9 @@
+"""
+Optics
+======
+
+*Optics* is the branch of physics which is concerned with light and its behavioural
+pattern and properties. Optics is a branch of physics that deals with the determination
+of behaviour and the properties of light, along with its interactions with the matter
+and also with the instruments which are used to detect it.
+"""
diff --git a/symplyphysics/laws/quantum_mechanics/__init__.py b/symplyphysics/laws/quantum_mechanics/__init__.py
@@ -0,0 +1,7 @@
+"""
+Quantum mechanics
+=================
+
+*Quantum mechanics* is a fundamental theory that describes the behavior of nature at and below the
+scale of atoms and deals with the behavior of matter and light on the atomic and subatomic scale.
+"""
diff --git a/symplyphysics/laws/quantum_mechanics/harmonic_oscillator/__init__.py b/symplyphysics/laws/quantum_mechanics/harmonic_oscillator/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Harmonic oscillator (Quantum mechanics)**
+===========================================
+
+The quantum harmonic oscillator is the quantum-mechanical analog of the classical harmonic oscillator.
+"""
diff --git a/symplyphysics/laws/quantum_mechanics/schrodinger/__init__.py b/symplyphysics/laws/quantum_mechanics/schrodinger/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Schrödinger equation**
+========================
+
+The Schrödinger equation is a partial differential equation that governs the wave function of a quantum-mechanical system.
+"""
diff --git a/symplyphysics/laws/relativistic/__init__.py b/symplyphysics/laws/relativistic/__init__.py
@@ -0,0 +1,7 @@
+r"""
+Relativistic
+============
+
+Relativistic mechanics is a field of science concerned with the motion of bodies whose relative
+velocities approach the speed of light :math:`c`.
+"""
diff --git a/symplyphysics/laws/relativistic/vector/__init__.py b/symplyphysics/laws/relativistic/vector/__init__.py
@@ -0,0 +1,6 @@
+"""
+**Relativistic (Vector)**
+=========================
+
+A collection of laws related to a vectorial description of relativistic mechanics.
+"""
diff --git a/symplyphysics/laws/relativistic/waves/__init__.py b/symplyphysics/laws/relativistic/waves/__init__.py