Updated docs

doc/how_to_create_docs.txt

@@ -11,6 +11,11 @@ Any python that exeutes "sphinx-build" must have installed the same dependencies
 In short, if you want to compile the documentation locally, better use make.py, the others are there for read-the-docs.
 
 
-Use: `sphinx-apidoc -o ./rst_source/api/auto ../src/GridCal --tocfile modules` to build the api rst files
+Use:
+
+`sphinx-apidoc -o ./rst_source/api/auto ../src/GridCal --tocfile modules`
+`sphinx-apidoc -o ./rst_source/api/auto ../src/GridCalEngine --tocfile modules`
+
+to build the api rst files
 
 

doc/index.rst

@@ -1,26 +1,47 @@
 Welcome to GridCal's documentation!
 ===================================
 
-**GridCal** (abbreviation of Grid Calculator) is a power
-systems software that has been used for research and power systems
-consultancy since 2015.
-
-GridCal aims at being a fully usable software product by end users, while allowing
-power users to tweak it and extend it at will. GridCal is designed as a software
-library with a graphical user interface, and because of this you can use
-GridCal as a conventional software, or you may embed it into your own programs.
+GridCal is a top tier power systems planning and simulation software. As
+such it has all the static analysis studies that you can think of, plus
+linear and non-linear optimization functions. Some of these functions
+are well known, while others you may have never heard of as they are a
+product of cutting-edge research.
 
 .. figure:: rst_source/figures/GridCal.png
     :alt: GridCal main figure
 
-You may also check out the power systems theory used in GridCal along with interesting information in
-the author's
-`simulation guide <https://github.com/SanPen/PracticalGridModeling/raw/master/practical_grid_modeling.pdf>`_.
+|Codacy Badge| |Documentation Status| |Build Status| |DOI| |Downloads|
+
+GridCal started in 2015 with a clear objective: create a solid
+programming library and a user-friendly interface. This straightforward
+approach sparked many innovations — some driven by the necessity for
+commercial use, and others fueled by curiosity and research.
+
+Whether you’re a pro needing free tools, a researcher wanting a
+real-world tested platform, a teacher sharing commercial-grade software
+insights, or a student diving into practical algorithms, GridCal’s got
+your back. It’s a high quality product made for all of us now and for
+the future generations.
+
+Contact
+=======
+
+-  Join the `Discord GridCal
+   channel <https://discord.com/invite/dzxctaNbvu>`__ for a friendly
+   chat, or quick question.
+-  Submit questions or comments to our
+   `form <https://forms.gle/MpjJAntAwZiLwE6B6>`__.
+-  Submit bugs or requests in the
+   `Issues <https://github.com/SanPen/GridCal/issues>`__ section.
+-  Simply email `[email protected] <[email protected]>`__
+
+Contents
+=========
 
 .. toctree::
-    :maxdepth: 3
+    :maxdepth: 1
 
-    rst_source/about
+    rst_source/license
     rst_source/getting_started
     rst_source/tutorials/tutorials_module
     rst_source/data_sheets
@@ -32,4 +53,21 @@ the author's
     rst_source/change_log
     rst_source/api/auto/modules
 
-This documentation is generated using Sphinx and autodoc.
+
+Disclaimer
+----------
+
+All trademarks mentioned in the documentation or the source code belong
+to their respective owners.
+
+.. |image0| image:: pics/GridCal.png
+.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/75e794c9bcfd49bda1721b9ba8f6c790
+   :target: https://app.codacy.com/app/SanPen/GridCal?utm_source=github.com&utm_medium=referral&utm_content=SanPen/GridCal&utm_campaign=Badge_Grade_Dashboard
+.. |Documentation Status| image:: https://readthedocs.org/projects/gridcal/badge/?version=latest
+   :target: https://gridcal.readthedocs.io/en/latest/?badge=latest
+.. |Build Status| image:: https://travis-ci.org/SanPen/GridCal.svg?branch=master
+   :target: https://travis-ci.org/SanPen/GridCal
+.. |DOI| image:: https://www.zenodo.org/badge/49583206.svg
+   :target: https://www.zenodo.org/badge/latestdoi/49583206
+.. |Downloads| image:: https://static.pepy.tech/personalized-badge/gridcal?period=total&units=abbreviation&left_color=grey&right_color=green&left_text=Downloads
+   :target: https://pepy.tech/project/gridcal

doc/rst_source/api/auto/modules.rst

@@ -1,7 +1,7 @@
-GridCal
-=======
+GridCalEngine API documentation
+===================================
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 3
 
-   GridCal
+   GridCalEngine

doc/rst_source/change_log.rst

@@ -6,6 +6,17 @@ This section describes the changes introduced at each Version.
 
 \* Short releases indicate the fix of a critical bug.
 
+Version 5.0.2
+^^^^^^^^^^^^^^^
+
+- Massive refactor to allow multiple bus-branch diagrams and maps.
+- The great split: Now there are two packages: `GridCal` which delas with the graphical user interface
+and `GridCalEngine` that provides all the engine functionality without Qt dependencies.
+- MIP auto-healing: OPF simuations are always feasible by properly relaxing infeasible ones.
+- Added cutting edge investments evaluation. This will be evolved in future releases.
+- API naming unification
+- Overall refactoring and bug fixing
+
 Version 4.7.0
 ^^^^^^^^^^^^^^^