fix docs spelling

README.md

+[comment]: \page README Readme
+
 # libeisdrt
 
 _libeisdrt_ is a c++ shared library to compute Distribution of Relaxation Times using Tikhonov regularization.

doc/mainpage.txt

@@ -12,11 +12,11 @@ This manual is divided in the following sections depending on what datatypes you
 
 ## Building
 
-the main devolpment platform of _libeisdrt_ is linux, and _libeisdrt_ works best on UNIX-like systems, however _libeisdrt_ is fully portable and should compile on any platform that supports the requriements below
+the main development platform of _libeisdrt_ is Linux, and _libeisdrt_ works best on UNIX-like systems, however _libeisdrt_ is fully portable and should compile on any platform that supports the requirements below
 
-### Requirments
-- [git](https://git-scm.com/) is requried to get the source
-- a C++20 compliant compiler like [gcc](https://gcc.gnu.org/)
+### Requirements
+- [git](https://git-scm.com/) is required to get the source
+- a C++20 compliant compiler like [GCC](https://gcc.gnu.org/)
 - [cmake](https://cmake.org/) version 3.19 or later
 - [libtorch](https://pytorch.org/get-started/locally/) is optional, but is required for libtorch Tensor support
 - [eisgenerator](https://git-ce.rwth-aachen.de/carl_philipp.klemm/eisgenerator) is optional, but is required for eisgenerator DataPoint support
@@ -36,7 +36,7 @@ $ make doc
 
 ## Usage
 
-The usage of this library can be infered from the API documentation linked above and from the following eisgenerator based example.
+The usage of this library can be inferred from the API documentation linked above and from the following eisgenerator based example.
 
 ### Example usage:
 
@@ -112,8 +112,8 @@ int main(int argc, char** argv)
 }
 ```
 
-# Licence
+# License
 
-_libeisdrt_ is licenced to you under the LGPL version 3 , or (at your option) any later version. see lgpl-3.0.txt or [LGPL](https://www.gnu.org/licenses/lgpl-3.0.en.html) for details
+_libeisdrt_ is licensed to you under the LGPL version 3 , or (at your option) any later version. see lgpl-3.0.txt or [LGPL](https://www.gnu.org/licenses/lgpl-3.0.en.html) for details
 
 */

eisdrt/eigendrt.h

@@ -23,9 +23,9 @@
 #include "types.h"
 
 /**
-Api for use with Eigen applications
+API for use with Eigen applications
 * @defgroup EIGENAPI Eigen API
-* calculates drts with eigen datatypes
+* calculates drts with Eigen datatypes
 * @{
 */
 
@@ -33,11 +33,11 @@ Api for use with Eigen applications
  * @brief calculate the drt using Eigen datatypes
  *
  * @tparam fv precision to be used, either double or float
- * @param impedanceSpectra vector with the complex impedances of your expirament
- * @param omegaTensor vector with the omega values that the impedances where mesured at
- * @param fm a fit metrics struct where this function returns information on the fit aquired
+ * @param impedanceSpectra vector with the complex impedances of your experiment
+ * @param omegaTensor vector with the omega values that the impedances where measured at
+ * @param fm a fit metrics struct where this function returns information on the fit acquired
  * @param fp a struct with fit parameters
- * @param rSeries an optional paramter where the seires resistance is stored
+ * @param rSeries an optional parameter where the series resistance is stored
  * @return a vector with the drt values
  */
 template<typename fv>
@@ -46,12 +46,12 @@ Eigen::VectorX<fv> calcDrt(Eigen::VectorX<std::complex<fv>>& impedanceSpectra, E
 
 
 /**
- * @brief calculate impedance from drt using eigen datatypes
+ * @brief calculate impedance from drt using Eigen datatypes
  *
  * @tparam fv precision to be used, either double or float
- * @param drt the drt to caluclate impedance from
- * @param omegaVector vector with the omega values that the impedances where mesured at
- * @param rSeries an optional paramter where the seires resistance is stored
+ * @param drt the drt to calculate impedance from
+ * @param omegaVector vector with the omega values that the impedances where measured at
+ * @param rSeries an optional parameter where the series resistance is stored
  * @return a vector with the drt values
  */
 template<typename fv>

eisdrt/eisdrt.h

@@ -23,7 +23,7 @@
 #include "types.h"
 
 /**
-Api for use with eisgenerator applications
+API for use with eisgenerator applications
 * @defgroup EISAPI eisgenerator API
 * calculates drts with eisgenerator datatypes
 * @{
@@ -32,11 +32,11 @@ Api for use with eisgenerator applications
 /**
  * @brief calculate a drt on eisgenerator types
  *
- * @param data a vector of eisgenerator datapoints with the values to your expirament, embedded omega values are ignored
- * @param omegaVector vector with the omega values that the impedances where mesured at
- * @param fm a fit metrics struct where this function returns information on the fit aquired
+ * @param data a vector of eisgenerator data points with the values to your experiment, embedded omega values are ignored
+ * @param omegaVector vector with the omega values that the impedances where measured at
+ * @param fm a fit metrics struct where this function returns information on the fit acquired
  * @param fp a struct with fit parameters
- * @param rSeries an optional paramter where the seires resistance is stored
+ * @param rSeries an optional parameter where the series resistance is stored
  * @return a vector with the drt values
  */
 std::vector<fvalue> calcDrt(const std::vector<eis::DataPoint>& data, const std::vector<fvalue>& omegaVector, FitMetics& fm,
@@ -45,10 +45,10 @@ std::vector<fvalue> calcDrt(const std::vector<eis::DataPoint>& data, const std::
 /**
  * @brief calculate a drt on eisgenerator types
  *
- * @param data a vector of eisgenerator datapoints with the values to your expirament, embedded omega values are used
- * @param fm a fit metrics struct where this function returns information on the fit aquired
+ * @param data a vector of eisgenerator data points with the values to your experiment, embedded omega values are used
+ * @param fm a fit metrics struct where this function returns information on the fit acquired
  * @param fp a struct with fit parameters
- * @param rSeries an optional paramter where the seires resistance is stored
+ * @param rSeries an optional parameter where the series resistance is stored
  * @return a vector with the drt values
  */
 std::vector<fvalue> calcDrt(const std::vector<eis::DataPoint>& data, FitMetics& fm, const FitParameters& fp, fvalue* rSeries = nullptr);
@@ -56,9 +56,9 @@ std::vector<fvalue> calcDrt(const std::vector<eis::DataPoint>& data, FitMetics&
 /**
  * @brief calculate impedance from drt using eisgenerator datatypes
  *
- * @param drt the drt to caluclate impedance from
- * @param omegaVector vector with the omega values that the impedances where mesured at
- * @param rSeries an optional paramter where the seires resistance is stored
+ * @param drt the drt to calculate impedance from
+ * @param omegaVector vector with the omega values that the impedances where measured at
+ * @param rSeries an optional parameter where the series resistance is stored
  * @return a vector with the impedance values
  */
 std::vector<eis::DataPoint> calcImpedance(const std::vector<fvalue>& drt, fvalue rSeries, const std::vector<fvalue>& omegaVector);
@@ -66,9 +66,9 @@ std::vector<eis::DataPoint> calcImpedance(const std::vector<fvalue>& drt, fvalue
 /**
  * @brief calculate impedance from drt using eisgenerator datatypes
  *
- * @param drt the drt to caluclate impedance from
+ * @param drt the drt to calculate impedance from
  * @param omegaRange range that describes the omega values the drt was taken at
- * @param rSeries an optional paramter where the seires resistance is stored
+ * @param rSeries an optional parameter where the series resistance is stored
  * @return a vector with the impedance values
  */
 std::vector<eis::DataPoint> calcImpedance(const std::vector<fvalue>& drt, fvalue rSeries, const eis::Range& omegaRange);

eisdrt/torchdrt.h

@@ -32,9 +32,9 @@ Api for use with libtorch applications
  * @brief calculate a drt on eisgenerator types
  *
  * @tparam fv precision to be used, either double or float
- * @param impedanceSpectra a 1d complex tensor with the impedance mesurement data points
- * @param omegaTensor a 1d tensor with the omega values that the impedances where mesured at
- * @param fm a fit metrics struct where this function returns information on the fit aquired
+ * @param impedanceSpectra a 1d complex tensor with the impedance measurement data points
+ * @param omegaTensor a 1d tensor with the omega values that the impedances where measured at
+ * @param fm a fit metrics struct where this function returns information on the fit acquired
  * @param fp a struct with fit parameters
  * @return a 1d tensor with the drt values
  */
@@ -45,7 +45,7 @@ torch::Tensor calcDrtTorch(torch::Tensor& impedanceSpectra, torch::Tensor& omega
  * @brief calculates impedance from drt
  *
  * @tparam fv precision to be used, either double or float
- * @param drt the drt to calcualte impedance from
+ * @param drt the drt to calculate impedance from
  * @return a complex tensor with the impedance spectra
  */
 template<typename fv>

eisdrt/types.h

@@ -30,7 +30,7 @@ Types for use with all eisdrt apis
 
 
 /**
- * @brief Exception thrown if drt could not be calcualted
+ * @brief Exception thrown if drt could not be calculated
  */
 class drt_errror: public std::exception
 {
@@ -49,9 +49,9 @@ public:
  */
 struct FitMetics
 {
-	int iterations;	/**< how many itterations where used */
+	int iterations;	/**< how many iterations where used */
 	double fx;		/**< error function value remaining after fit */
-	bool compleated;	/**< true if fit compleated sucessfully */
+	bool compleated;	/**< true if fit completed successfully */
 };
 
 struct FitParameters