update documentation

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- cooling system r_th calculation 
+- cooling system pressure drop calculation
+- heat spreading calculation
+
+[unreleased]: https://github.com/upb-lea/HCT_heat_sink_computation_toolbox/compare/v1.1.1...HEAD
+#[0.0.2]: https://github.com/upb-lea/HCT_heat_sink_computation_toolbox/compare/v0.0.1...v0.0.2
+#[0.0.1]: https://github.com/upb-lea/HCT_heat_sink_computation_toolbox/releases/tag/v0.0.1

README.md

@@ -1,4 +1,15 @@
 # Welcome to the heat sink computation toolbox
+Heat sink dimensioning based on analytical calculation of thermal resistance. 
+
+![](documentation/geometry_operating_point.png)
+
+The pressure loss through the cooling system is determined by the specified geometry and the fan. This allows the volume flow rate to be determined. The volume flow can then be used to determine the thermal resistance.
+
+
+The estimate of the geometry parameters and the fan is mapped to the costs (volume, R_th) using Pareto optimization. 
+About 40 fan characteristic curves are stored in the toolbox.
+
+![](documentation/pareto_example.png)
 
 ## Installation
 Install in developer mode.
@@ -8,10 +19,25 @@ cd HCT_heat_sink_computation_toolbox/
 pip install -e .
 ```
 
-## Source
+## Literature
 This toolbox implements the thermal basics according to the following paper:
 ```
 Christoph Gammeter, Florian Krismer and Johann W. Kolar
 Weight Optimization of a Cooling Sysetm Composed of Fan and Extruded Fin Heat Sink
 ```
-This is supplemented by various calculations and optimizations. 
+Heat spreading is implemented according to the following Ph.D. thesis:
+```
+Christoph Gammeter
+Multi-Objective Optimization of Power Electronics and Generators of Airborne Wind Turbines
+```
+This is supplemented by various calculations and optimizations. E.g. a Pareto optimization is added.
+
+## Bug reports
+Please use the issues report button within GitHub to report bugs.
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## Changelog
+Find the changelog [here](CHANGELOG.md).
+