Merge pull request #8 from Gurobi/v2-update

clean up a few things and prepare v2.0.0 release

README.md

@@ -1,18 +1,10 @@
-<!---
-
-**⚠ Warning**
-
-```This code is in a pre-release state. It may not be fully functional and breaking changes can occur without notice.```
-
---->
-
 # Gurobi Model Analyzer
 
 Gurobi Model Analyzer is an
 [open-source](https://gurobi-modelanalyzer.readthedocs.io/en/stable/license.html) python package that provides
 detailed analysis of model solutions and model characteristics.
-Version 1.0 consists of a results_analyzer module that calculates
-explanations of ill-conditioned basis matrices.
+It consists of a results_analyzer module that calculates
+explanations of ill-conditioned basis matrices and a solcheck module that analysizes a given solution.
 
 
 # Documentation
@@ -39,7 +31,7 @@ If you encounter issues with Gurobi or gurobipy please contact
 - Python >= 3.9
 - [`numpy`](https://pypi.org/project/numpy/)  >= 1.21.5    (although earlier
   versions compatible with python 3.7 will probably work).
-
+- [questionary](https://pypi.org/project/questionary/) for the (optional) interactive version
 
 ## Pip installation
 
@@ -144,16 +136,6 @@ Other useful resources to get started:
 We value any level of experience in using Gurobi Model Analyzer and would like to encourage you to
 contribute directly to this project. Please see the [Contributing Guide](CONTRIBUTING.md) for more information.
 
-## Source code
-You can clone the latest sources with the command:
-
-```
-git clone [email protected]:Gurobi/gurobi-modelanalyzer.git
-```
-
-
-## Testing
-
 
 ## Submitting a Pull Request
 Before opening a Pull Request, have a look at the full

docs/source/_templates/sidebar/brand.html

@@ -0,0 +1,28 @@
+{#-
+
+Adapted from the furo theme template at:
+https://github.com/pradyunsg/furo/blob/main/src/furo/theme/furo/sidebar/brand.html
+
+- Making the logo link to Gurobi.com
+- Make the project string link to master_doc
+
+-#}
+<a class="sidebar-brand{% if logo %} centered{% endif %}" href="https://www.gurobi.com">
+  {% block brand_content %}
+  {%- if logo_url %}
+  <div class="sidebar-logo-container">
+    <img class="sidebar-logo" src="{{ logo_url }}" alt="Logo"/>
+  </div>
+  {%- endif %}
+  {%- if theme_light_logo and theme_dark_logo %}
+  <div class="sidebar-logo-container">
+    <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/>
+    <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/>
+  </div>
+  {%- endif %}
+</a>
+    <br>
+  <a href="{{ pathto(master_doc) }}"
+  <span class="sidebar-brand-text" >{{ docstitle if docstitle else project }}</span>
+  </a>
+  {% endblock brand_content %}

docs/source/index.rst

@@ -3,16 +3,6 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. image:: _static/image8.png
-     :width: 220
-     :target: https://www.gurobi.com
-     :alt: Gurobi
-     :class: float-right
-
-..  rst-class::  clear-both
-
-
-
 
 Gurobi Modelanalyzer
 ====================
@@ -24,6 +14,9 @@ explanations of ill conditioned basis matrices.  Additional modules
 to provide detailed information about model data shall be provided in
 future versions.
 
+The included solcheck module is used to analyze feasibility of a
+provided solution to a model instance.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "gurobi-modelanalyzer"
-description = "Model analysis tools; v1.0 is an ill conditioning explainer."
+description = "Model analysis tools for explaining ill-conditioning and analyzing solutions."
 readme = "README.md"
 requires-python = ">=3.8"
 license = "Apache-2.0"