Skip to content

Commit

Permalink
[ci skip] update readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
phoebe-p committed Sep 26, 2024
1 parent f14f8be commit 1a89693
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
4 changes: 3 additions & 1 deletion docs/source/Examples/main.rst
Original file line number Diff line number Diff line change
@@ -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) <https://github.com/dalonsoa/solcore5>`_ 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) <https://github.com/qpv-research-group/solcore5>`_,
and on the `solcore-education website <https://qpv-research-group.github.io/solcore-education/solcore-workshop-2/workshop2023.html>`_.

Quantum solvers
---------------
Expand Down Expand Up @@ -43,3 +44,4 @@ SPICE-based solar cell solver
- :doc:`PV module calculator <example_pv_module>`
- :doc:`Quasi-3D 3J solar cell <example_quasi3D_cell>`


0 comments on commit 1a89693

Please sign in to comment.