From 1a896939c2fc4327a2671d9f56b45a23393866cc Mon Sep 17 00:00:00 2001 From: Phoebe Pearce Date: Thu, 26 Sep 2024 16:33:18 +0200 Subject: [PATCH] [ci skip] update readme and docs --- README.md | 6 ++++-- docs/source/Examples/main.rst | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 917bddd4..80e5a788 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,19 @@ [![image](https://zenodo.org/badge/DOI/10.5281/zenodo.1185316.svg)](https://doi.org/10.5281/zenodo.1185316) [![image](https://img.shields.io/badge/License-LGPLv3-blue.svg)](http://www.gnu.org/licenses/lgpl.html) [![Documentation Status](http://readthedocs.org/projects/solcore5/badge/?version=latest)](http://solcore5.readthedocs.io/en/latest/?badge=latest) -![Solcore](https://github.com/qpv-research-group/solcore5/workflows/Solcore/badge.svg) +![Solcore](https://github.com/qpv-research-group/solcore5/actions/workflows/test_unit_and_examples.yml/badge.svg) [![codecov](https://codecov.io/gh/qpv-research-group/solcore5/branch/develop/graph/badge.svg)](https://codecov.io/gh/qpv-research-group/solcore5) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/a1d2e6f702e64d878a67dcf85ce9b3b7)](https://app.codacy.com/gh/qpv-research-group/solcore5?utm_source=github.com&utm_medium=referral&utm_content=qpv-research-group/solcore5&utm_campaign=Badge_Grade_Settings) - Solcore ======= **Solcore** was born as a modular set of tools, written (almost) entirely in Python 3, to address some of the task we had to solve more. With time, however, it has evolved as a complete semiconductor solver able of modelling the optical and electrical properties of a wide range of solar cells, from quantum well devices to multi-junction solar cells. Please, visit [Solcore\'s Documentation](http://docs.solcore.solar), the [Tutorial](docs/source/Examples/tutorial.rst) for a step-by-step example of how to use *Solcore* to model a solar cell and also check the [Examples folder](examples) for more specific information and examples of usage. + +If you would like to be kept up to date on (important) releases and new features, please join the Solcore/RayFlare mailing list +[here](https://www.solcore.solar/mailing-list). ![](docs/source/Infographics.jpg) diff --git a/docs/source/Examples/main.rst b/docs/source/Examples/main.rst index 8e8ced00..0e5b7715 100755 --- a/docs/source/Examples/main.rst +++ b/docs/source/Examples/main.rst @@ -1,7 +1,8 @@ Examples ======== -List of examples illustrating the use of Solcore. More examples are available in the `Solcore's Github repository (Examples folder) `_ and will be listed here at some point +List of examples illustrating the use of Solcore. More examples are available in the `Solcore's Github repository (Examples folder) `_, +and on the `solcore-education website `_. Quantum solvers --------------- @@ -43,3 +44,4 @@ SPICE-based solar cell solver - :doc:`PV module calculator ` - :doc:`Quasi-3D 3J solar cell ` +