Merge pull request #440 from jinningwang/doc

Update doc to promote CURENT
CURENT · Apr 23, 2023 · c050f89 · c050f89
2 parents b928120 + 6628453
commit c050f89
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 34 deletions.
diff --git a/.azure-pipelines/azure-pipelines-linux.yml b/.azure-pipelines/azure-pipelines-linux.yml
@@ -28,7 +28,6 @@ jobs:
       pip install pytest pytest-azurepipelines
       coverage run -m pytest  # Run the tests and check for test coverage.
       coverage report -m  # Generate test coverage report.
-      codecov  # Upload the report to codecov.
     displayName: 'pytest and coverage'
 
   - script: |

diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
-# ANDES
+# LTB ANDES
 
-Python Software for Symbolic Power System Modeling and Numerical Analysis.
+<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
+
+Python software for symbolic power system modeling and numerical analysis, serving as the core simulation engine for the [CURENT Largescale Testbed][LTB Repository].
 
 |               | Latest                                                                                                                                        | Stable                                                                                                                                        |
 |---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
@@ -53,7 +55,7 @@ Numerical code will be automatically generated for fast simulation.
 
 | Controller Model and Equation | ANDES Code |
 | ----------------------------- | ---------- |
-| Diagram: <br> ![](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/modeling/example-tgov1/tgov1.png) <br><br> Write into DAEs: <br> ![](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/modeling/example-tgov1/tgov1_eqns.png)  | ![](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/modeling/example-tgov1/tgov1_class.png) |
+| Diagram:  <br> ![](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/modeling/example-tgov1/tgov1.png)  <br>  Write into DAEs:  <br>  ![](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/modeling/example-tgov1/tgov1_eqns.png)  | ![](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/modeling/example-tgov1/tgov1_class.png) |
 
 In ANDES, what you simulate is what you document.
 ANDES automatically generates model documentation, and the docs always stay up to date.
@@ -100,17 +102,13 @@ H. Cui, F. Li and K. Tomsovic, "Hybrid Symbolic-Numeric Framework for Power Syst
 Please let us know if you are using ANDES for research or projects.
 We kindly request you to cite our [paper][arxiv paper] if you find ANDES useful.
 
-![Natinoal Science Foundation](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/images/sponsors/nsf.jpg)
-![US Department of Energy](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/images/sponsors/doe.png)
-![CURENT ERC](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/images/sponsors/curent.jpg)
-![Lawrence Livermore National Laboratory](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/images/sponsors/llnl.jpg)
-![Idaho National Laboratory](https://raw.githubusercontent.com/cuihantao/andes/master/docs/source/images/sponsors/inl.jpg)
+![Natinoal Science Foundation](https://raw.githubusercontent.com/CURENT/andes/master/docs/source/images/sponsors/nsf.jpg)
+![US Department of Energy](https://raw.githubusercontent.com/CURENT/andes/master/docs/source/images/sponsors/doe.png)
+![CURENT ERC](https://raw.githubusercontent.com/CURENT/andes/master/docs/source/images/sponsors/curent.jpg)
+![Lawrence Livermore National Laboratory](https://raw.githubusercontent.com/CURENT/andes/master/docs/source/images/sponsors/llnl.jpg)
+![Idaho National Laboratory](https://raw.githubusercontent.com/CURENT/andes/master/docs/source/images/sponsors/inl.jpg)
 
 # Sponsors and Contributors
-ANDES is the core simulation engine for the CURENT Largescale Testbed (LTB).
-More information about CURENT LTB can be found at the
-[LTB Repository](https://github.com/CURENT/ltb2).
-
 This work was supported in part by the Engineering Research Center
 Program of the National Science Foundation and the Department of Energy
 under NSF Award Number EEC-1041877 and the CURENT Industry Partnership
@@ -127,16 +125,17 @@ ANDES is licensed under the [GPL v3 License](./LICENSE).
 
 * * *
 
-[GitHub releases]:       https://github.com/cuihantao/andes/releases
-[GitHub issues]:         https://github.com/cuihantao/andes/issues
-[Github Discussions]:    https://github.com/cuihantao/andes/discussions
-[GitHub insights]:       https://github.com/cuihantao/andes/pulse
-[GitHub pull requests]:  https://github.com/cuihantao/andes/pulls
-[GitHub contributors]:   https://github.com/cuihantao/andes/graphs/contributors
+[GitHub releases]:       https://github.com/CURENT/andes/releases
+[GitHub issues]:         https://github.com/CURENT/andes/issues
+[Github Discussions]:    https://github.com/CURENT/andes/discussions
+[GitHub insights]:       https://github.com/CURENT/andes/pulse
+[GitHub pull requests]:  https://github.com/CURENT/andes/pulls
+[GitHub contributors]:   https://github.com/CURENT/andes/graphs/contributors
 [readthedocs]:           https://andes.readthedocs.io
 [release notes]:         https://andes.readthedocs.io/en/latest/release-notes.html
 [arxiv paper]:           https://arxiv.org/abs/2002.09455
 [tutorial]:              https://andes.readthedocs.io/en/latest/tutorial.html#interactive-usage
-[examples]:              https://github.com/cuihantao/andes/tree/master/examples
-[verification]:          https://github.com/cuihantao/andes/tree/master/examples/verification
+[examples]:              https://github.com/CURENT/andes/tree/master/examples
+[verification]:          https://github.com/CURENT/andes/tree/master/examples/verification
 [Binder]:                https://mybinder.org/v2/gh/cuihantao/andes/master
+[LTB Repository]:       https://github.com/CURENT
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -213,7 +213,7 @@
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
     'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None),
-    'matplotlib': ('https://matplotlib.org', None),
+    # 'matplotlib': ('https://matplotlib.org', None),
 }
 
 # Favorite icon

diff --git a/docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png b/docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png
diff --git a/docs/source/images/sponsors/CURENT_Logo_Transparent.png b/docs/source/images/sponsors/CURENT_Logo_Transparent.png
diff --git a/docs/source/images/sponsors/CURENT_Logo_Transparent_Name.png b/docs/source/images/sponsors/CURENT_Logo_Transparent_Name.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -15,27 +15,30 @@ ANDES documentation
 
 
 **Useful Links**: `Binary Installer`_ | `Source Repository`_ | `Report Issues`_
-| `Q&A`_ | `Try in Jupyter Notebooks`_
+| `Q&A`_ | `Try in Jupyter Notebooks`_ | `LTB Repository`_
 
-.. _`Source Repository`: https://github.com/cuihantao/andes
-.. _`Report Issues`: https://github.com/cuihantao/andes/issues
-.. _`Q&A`: https://github.com/cuihantao/andes/discussions
+.. _`Source Repository`: https://github.com/CURENT/andes
+.. _`Report Issues`: https://github.com/CURENT/andes/issues
+.. _`Q&A`: https://github.com/CURENT/andes/discussions
 .. _`Binary Installer`: https://pypi.org/project/andes/
 .. _`Try in Jupyter Notebooks`: https://mybinder.org/v2/gh/cuihantao/andes/master
-.. _`LTB Repository`: https://github.com/CURENT/ltb2
+.. _`LTB Repository`: https://github.com/CURENT/
 
-ANDES is an open-source Python library for power system modeling, computation,
-analysis, and control. It supports power flows calculation, transient stability
+.. image:: /images/sponsors/CURENT_Logo_NameOnTrans.png
+   :alt: CURENT Logo
+   :width: 300px
+   :height: 74.2px
+
+LTB ANDES is an open-source Python library for power system modeling, computation,
+analysis, and control, serving as the core simulation engine for the CURENT Large scale
+Testbed (LTB). It supports power flows calculation, transient stability
 simulation, and small-signal stability analysis for transmission systems. ANDES
 implements a symbolic-numeric framework for rapid prototyping of
 differential-algebraic equation-based models. In this framework, a comprehensive
 :ref:`library of models <modelref>` is developed, including the full
 second-generation renewable models. Models in ANDES have been :ref:`verified
 <verification>` with commercial software.
 
-ANDES is the core simulation engine for the CURENT Largescale Testbed (LTB).
-More information about CURENT LTB can be found at the `LTB Repository`_.
-
 .. panels::
     :card: + intro-card text-center
     :column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex

diff --git a/requirements-extra.txt b/requirements-extra.txt
@@ -7,7 +7,6 @@
 #
 # Only one `#` is allowed per line. Lines starting with `#` are ignored.
 
-codecov #                      dev
 coverage #                     dev
 pytest==7.0.1 #                dev
 flake8 #                       dev
@@ -24,7 +23,6 @@ pre-commit #                   dev
 numba #                        dev, perf
 
 pandapower #                   interop
-GridCal #                      interop
 
 # below work around a bug with tqdm bar with ipywidgets 8.0.1
 ipywidgets==7.7 #              web