Fix a lot of small typos

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2022, oemof developer group
+Copyright (c) 2017-2023 Francesco Witte
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -3,8 +3,8 @@ Thermal Engineering Systems in Python
 TESPy stands for "Thermal Engineering Systems in Python" and provides a
 powerful simulation toolkit for thermal engineering plants such as power
 plants, district heating systems or heat pumps. It is an external extension
-module within the `Open Energy Modelling Framework <https://oemof.org/>`_ and
-can be used as a standalone package.
+module within the Open Energy Modelling Framework `oemof <https://oemof.org/>`_
+and can be used as a standalone package.
 
 .. figure:: https://raw.githubusercontent.com/oemof/tespy/9915f013c40fe418947a6e4c1fd0cd0eba45893c/docs/api/_images/logo_tespy_big.svg
     :align: center
@@ -20,8 +20,8 @@ exchangers, drum).
 Everybody is welcome to use and/or develop TESPy. Contribution is already
 possible on a low level by simply fixing typos in TESPy's documentation or
 rephrasing sections which are unclear. If you want to support us that way
-please fork the TESPy repository to your own github account and make changes
-as described in the github guidelines:
+please fork the TESPy repository to your own GitHub account and make changes
+as described in the GitHub guidelines:
 https://guides.github.com/activities/hello-world/
 
 Key Features
@@ -130,7 +130,7 @@ We have decided to start a reoccurring "Stammtisch" meeting for all interested
 TESPy users and (potential) developers. You are invited to join us on every 3rd
 Monday of a month at 17:00 CE(S)T for a casual get together. The first meeting
 will be held at June, 20, 2022. The intent of this meeting is to establish a
-more active and well connected network of TESPy users and developers.
+more active and well-connected network of TESPy users and developers.
 
 If you are interested, you can simply join the meeting at
 https://meet.jit.si/tespy_user_meeting. We are looking forward to seeing you!
@@ -153,7 +153,7 @@ repository. They are included in the "tutorial" directory.
 Citation
 ========
 The scope and functionalities of TESPy have been documented in a paper
-published in the Journal of Open Source Software with an OpenAccess license.
+published in the Journal of Open Source Software with an Open-Access license.
 Download the paper from https://doi.org/10.21105/joss.02178. As TESPy is a free
 software, we kindly ask that you add a reference to TESPy if you use the
 software for your scientific work. Please cite the article with the BibTeX
@@ -200,7 +200,7 @@ zenodo. Find your version here: https://doi.org/10.5281/zenodo.2555866.
 
 License
 =======
-Copyright (c) 2017-2022 oemof developer group
+Copyright (c) 2017-2023 Francesco Witte
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

announcement.html

@@ -1,4 +1,4 @@
 <a style="text-decoration: none; color: white;" href="https://github.com/oemof/oemof/wiki/Meeting-2023.11">
     <img style="vertical-align: middle;" src="https://raw.githubusercontent.com/oemof/tespy/docs/announcement-banner/docs/_static/images/logo_tespy_mini.svg">
-    <span style="vertical-align: middle;">Register now for the oemof meeting in Oberhausen, Nov. 22-24.</span>
+    <span style="vertical-align: middle;">Join oemof meeting in Oberhausen</span>
 </a>

docs/advanced/exergy.rst

@@ -22,7 +22,7 @@ thermodynamics, the conversion of heat and internal energy into work is
 limited. This constraint and the idea of destruction are applied to introduce a
 new concept: "Exergy".
 
-Exergy can be destroyed due to irreversibilities and is able to describe the
+Exergy can be destroyed due to irreversibility and is able to describe the
 quality of different energy forms. The difference in quality of different forms
 of energy shall be illustrated by the following example. 1 kJ of electrical
 energy is clearly more valuable than 1 kJ of energy in a glass of water at
@@ -92,12 +92,12 @@ potential exergy are neglected and therefore not considered as well.
     * - :code:`E_D`
       - exergy destruction
       - :math:`\dot{E}_\mathrm{D}`
-      - thermodynamic inefficienies associated with the irreversibilities
+      - thermodynamic inefficiencies associated with the irreversibility
         (entropy generation) within the system boundaries
     * - :code:`E_L`
       - exergy loss
       - :math:`\dot{E}_\mathrm{L}`
-      - thermodynamic inefficienies associated with the transfer of exergy
+      - thermodynamic inefficiencies associated with the transfer of exergy
         through material and energy streams to the surroundings
     * - :code:`epsilon`
       - exergetic efficiency
@@ -122,7 +122,7 @@ potential exergy are neglected and therefore not considered as well.
 
 Tutorial
 ========
-In this short tutorial, an exergy analysis is carried out for the so called
+In this short tutorial, an exergy analysis is carried out for the so-called
 "Solar Energy Generating System" (SEGS). The full python script is available on
 GitHub in an individual repository: https://github.com/fwitte/SEGS_exergy.
 
@@ -269,7 +269,7 @@ the API documentation of class :py:class:`tespy.tools.analyses.ExergyAnalysis`.
 After the setup of the exergy analysis, the
 :py:meth:`tespy.tools.analyses.ExergyAnalysis.analyse` method expects the
 definition of the ambient state, thus ambient temperature and ambient pressure.
-With these information, the analysis is carried out automatically. The value
+With this information, the analysis is carried out automatically. The value
 of the ambient conditions is passed in the network's (:code:`nw`) corresponding
 units.
 
@@ -300,7 +300,7 @@ destruction on the respective busses is calculated. On top of that, fuel and
 product exergy values as well as exergy loss are determined. The total exergy
 destruction must therefore be equal to the fuel exergy minus product exergy and
 minus exergy loss. The deviation of that equation is then calculated and
-checked versus a threshold value of :math:`10^{-3}` (to componesate for
+checked versus a threshold value of :math:`10^{-3}` (to compensate for
 rounding errors).
 
 .. math::
@@ -346,10 +346,10 @@ deselect the tables, e.g. by passing :code:`groups=False` to the method call.
     ean.print_results(groups=False, connections=False)
 
 For the component related tables, i.e. busses, components, aggregation and
-groups, the data are sorted in descending order for the given exergy destruction value
-of the individual entry. The component data contain fuel exergy, product exergy
-and exergy destruction values related to the component itself ignoring losses
-that might occur on the busses, for example, mechanical or electrical
+groups, the data are sorted in descending order for the given exergy destruction
+value of the individual entry. The component data contain fuel exergy, product
+exergy and exergy destruction values related to the component itself ignoring
+losses that might occur on the busses, for example, mechanical or electrical
 conversion losses in motors and generators. The bus data contain the respective
 information related to the conversion losses on the busses only. The
 aggregation data contain both, the component and the bus data. For instance,
@@ -362,7 +362,7 @@ exergy, while the product is the electrical energy.
 .. note::
 
   Please note, that in contrast to the component and bus data, group data do
-  not contain fuel and product exergy as well as exergy efficiency. Instead all
+  not contain fuel and product exergy as well as exergy efficiency. Instead, all
   exergy streams entering the system borders of the component group and all
   exergy streams leaving the system borders are calculated. On this basis, a
   graphical representation of the exergy flows in the network can be generated
@@ -434,7 +434,7 @@ exclude relatively small values from display.
 
 The coloring of the links is defined by the type of the exergy stream (bound
 to a specific fluid, fuel exergy, product exergy, exergy loss, exergy
-destruction or internal exergy streams not bound to mass flows). Therefore
+destruction or internal exergy streams not bound to mass flows). Therefore,
 colors can be assigned to these types of streams.
 
 .. note::

docs/api.rst

@@ -6,7 +6,7 @@ All component and connection property equations derive from balance equations
 for fluid composition, mass flow and energy in regarding thermal as well as
 hydraulic state and thermodynamic fluid property equations respectively.
 Standard literature is for example :cite:`Baehr2016,Epple2012,Bswirth2012`
-(german) :cite:`Epple2017` (english). Equations and properties from other
+(German) :cite:`Epple2017` (English). Equations and properties from other
 sources are cited individually.
 
 .. toctree::

docs/basics/district_heating.rst

@@ -107,7 +107,7 @@ Next, we want to investigate what happens, in case the
 - heat load varies.
 - overall temperature level in the heating system is reduced.
 
-To do that, we will use similar setups as show in the rankine cycle
+To do that, we will use similar setups as show in the Rankine cycle
 introduction. The :code:`KA` value of both pipes is assumed to be fixed, the
 efficiency of the pump and pressure losses in consumer and heat source are
 constant as well.

docs/basics/gas_turbine.rst

@@ -21,7 +21,7 @@ This tutorial introduces a new component, the combustion chamber. You will
 learn how to use the component and set up a simple open cycle gas turbine: It
 compresses air and burns fuel in the combustion chamber. The hot and
 pressurized flue gas expands in the turbine, which drives the compressor and
-the generator. You will also learn, how to use the fluid compositon as a
+the generator. You will also learn, how to use the fluid composition as a
 variable in your simulation.
 
 Download the full script here:
@@ -238,7 +238,7 @@ hydrogen and methane.
     With this setup, a thermal input below the lower heating value of methane
     or above the lower heating value of hydrogen (each multiplied with the
     mass flow of 1 kg/s) does not make sense as input specification. This is
-    individual of every fluid you use as fuel and you cannot easily abstract
+    individual of every fluid you use as fuel, and you cannot easily abstract
     the values to any other combination.
 
 .. dropdown:: Click to expand to code section

docs/basics/heat_pump.rst

@@ -29,8 +29,8 @@ Download the full script here:
 Flexibility in Modeling
 ^^^^^^^^^^^^^^^^^^^^^^^
 In TESPy the specifications for components and/or connections are
-interchangable in every possible way, provided that the system of equations
-representing the plant is well defined.
+interchangeable in every possible way, provided that the system of equations
+representing the plant is well-defined.
 
 For example, instead of the heat provided by the condenser we could specify
 the mass flow :code:`m` of the refrigerant. To unset a parameter you need to
@@ -46,7 +46,7 @@ You can observe, that the heat transferred by the condenser now is a result of
 the mass flow specified. We could do similar things, for example with the heat
 sink temperature. We specified it in our initial set up. Now we want to insert
 a compressor with a fixed output to input pressure ratio. In that case, we
-cannot choose the condensation temperature but it will be a result of that
+cannot choose the condensation temperature, but it will be a result of that
 specification:
 
 .. literalinclude:: /../tutorial/basics/heat_pump.py
@@ -65,7 +65,7 @@ compressor would be, in case we measure :code:`T=97.3` at connection 3.
 
 Typical Errors
 ^^^^^^^^^^^^^^
-If you over- or underdetermine the system by specifying too few or too many
+If you over or under determine the system by specifying too few or too many
 parameters, you will get an error message. We could set the heat demand and the
 mass flow at the same time.
 
@@ -168,4 +168,4 @@ plot using matplotlib.
 
 The figure shows the results of the COP analysis. The base case is at an
 evaporation temperature of 20 °C, the condensation temperature at 80 °C and the
-isentropic effficiency of the compressor at 85 %.
+isentropic efficiency of the compressor at 85 %.

docs/basics/intro.rst

@@ -50,7 +50,7 @@ to specify parameters for the component, for example power :math:`P` for a pump
 or upper terminal temperature difference :math:`ttd_\mathrm{u}` of a heat
 exchanger. The full list of parameters for a specific component is stated in
 the respective class documentation. This example uses a compressor, a control
-valve two (simple) heat exchangers and a so called cycle closer.
+valve two (simple) heat exchangers and a so-called cycle closer.
 
 .. note::
 
@@ -76,8 +76,8 @@ Establish connections
 Connections are used to link two components (outlet of component 1 to inlet of
 component 2: source to target). If two components are connected with each other
 the fluid properties at the source will be equal to the properties at the
-target. It is possible to set the properties on each connection in a similar
-way as parameters are set for components. The basic specification options are:
+target. It is possible to set the properties on each connection similarly as
+parameters are set for components. The basic specification options are:
 
 * mass flow (m)
 * volumetric flow (v)
@@ -106,13 +106,13 @@ we do not need to pass the components to the network.
 .. note::
 
     The :code:`CycleCloser` is a necessary component when working with closed
-    cycles, because a system would always be overdetermined, if, for example,
+    cycles, because a system would always be over determined, if, for example,
     a mass flow is specified at some point within the cycle. It would propagate
-    through all of the components, since they have an equality constraint for
-    the mass flow at their inlet and their outlet. With the example here, that
-    would mean: **Without the cycle closer** specification of massflow at an
-    connection would lead to the following set of equations for massflow, which
-    is an overdetermination:
+    through all the components, since they have an equality constraint for the
+    mass flow at their inlet and their outlet. With the example here, that would
+    mean: **Without the cycle closer** specification of mass flow at a
+    connection would lead to the following set of equations for mass flow, which
+    is an over determination:
 
     .. math::
 
@@ -166,15 +166,15 @@ with the respective component parameters.
 Next steps
 ----------
 
-We highly recommend to check our other basic model examples on how to set up
+We highly recommend checking our other basic model examples on how to set up
 different standard thermodynamic cycles in TESPy. The heat pump cycle in that
-section builds on this heat pump. We will introduce couple of different inputs
+section builds on this heat pump. We will introduce a couple of different inputs
 and show, how to change the working fluid. The other tutorials show the usage
 of more components, for example the combustion chamber and the turbine or a
 condenser including the cooling water side of the system.
 
 In the more advanced tutorials, you will learn, how to set up more complex
-plants ste by step, make a design calculation of the plant as well as calculate
+plants step by step, make a design calculation of the plant as well as calculate
 offdesign/partload performance.
 
 In order to get a good overview of the TESPy functionalities, the sections on

docs/basics/rankine_cycle.rst

@@ -164,9 +164,9 @@ can disable the printout of the convergence history.
 Partload Simulation
 ^^^^^^^^^^^^^^^^^^^
 In the partload simulation part, we are starting with a specific design of the
-plant and calculate the partload perfomance with some assumptions on the
+plant and calculate the partload performance with some assumptions on the
 component's individual behavior. The table below summarizes the assumptions,
-which we will keep as simple as possible in this moment. For more insights
+which we will keep as simple as possible at this moment. For more insights
 have a look at the step by step
 :ref:`heat pump tutorial <tespy_tutorial_heat_pump_label>` or at the
 :ref:`Network documentation <tespy_modules_networks_label>`.
@@ -189,7 +189,7 @@ With these specifications, the following physics are applied to the model:
 
 - Due to the constant volumetric flow of water, the temperature of the cooling
   water returning from the condenser will react to the total heat transferred
-  in the condensation: Increased heat transfer means incresing temperature,
+  in the condensation: Increased heat transfer means increasing temperature,
   decreased heat transfer means decreased temperature.
 - The constant heat transfer coefficient of the condenser will calculate the
   condensation temperature (and therefore pressure) based on the temperature

docs/benchmarks.rst

@@ -8,7 +8,7 @@ Model Validation
 TESPy has been used to model several research and engineering applications. In
 the paper on integration of generic exergy analysis in TESPy
 :cite:`Witte2022` three models have been built from literature sources: A
-solar thermal power plant, a supercritical CO2 brayton cycle as well as a
+solar thermal power plant, a supercritical CO2 Brayton cycle as well as a
 refrigeration machine using air as working fluid.
 
 For the solar thermal power plant we have created a full model of the plant

docs/development/how.rst

@@ -12,7 +12,7 @@ Install the developer version
 
 It is recommenden to use
 `virtual environments <https://docs.python.org/3/tutorial/venv.html>`_ for
-the development process. Fork the repository and clone your forked tespy github
+the development process. Fork the repository and clone your forked tespy GitHub
 repository and install development requirements with pip.
 
 .. code:: bash
@@ -33,21 +33,21 @@ the example below).
     git fetch upstream
     git pull upstream dev --rebase
 
-Use the :code:`--rebase` comand to avoid merge commits fo every upstream pull.
+Use the :code:`--rebase` command to avoid merge commits for every upstream pull.
 If you want to make changes to tespy, checkout a new branch from your local dev
 branch. Make your changes, commit them and create a PR on the oemof/tespy dev
 branch.
 
 Collaboration with pull requests
 --------------------------------
 
-To collaborate use the pull request functionality of github as described here:
+To collaborate use the pull request functionality of GitHub as described here:
 https://guides.github.com/activities/hello-world/
 
 How to create a pull request
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* Fork the oemof repository to your own github account.
+* Fork the oemof repository to your own GitHub account.
 * Change, add or remove code.
 * Commit your changes.
 * Create a pull request and describe what you will do and why. Please use the
@@ -79,7 +79,7 @@ The tests in TESPy are split up in two different parts:
 
 The tests contain code examples that expect a certain outcome. If the outcome
 is as expected a test will pass, if the outcome is different, the test will
-fail. You can run the tests locally by navigating into your local github clone.
+fail. You can run the tests locally by navigating into your local GitHub clone.
 The command :code:`check` tests PEP guidelines, the command :code:`docs`
 tests building the documentation, and the command :code:`py3X` runs the
 software tests in the selected Python version.