Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
crvernon committed May 24, 2023
1 parent 684b668 commit 0354f04
Showing 1 changed file with 105 additions and 106 deletions.
211 changes: 105 additions & 106 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,106 +1,105 @@
:notoc:

cerf documentation
==================

**Date**: |today| **Version**: |version|

**Useful links**:
`Source Repository <https://github.com/immm-sfa/cerf>`_ |
`Issues & Ideas <https://github.com/immm-sfa/cerf/issues>`_ |
`Interactive Quickstarter <quickstarter.rst>`_

**cerf** is an open-source geospatial Python package for evaluating and analyzing future electricity technology capacity expansion feasibility. **cerf** was created to:

1) Evaluate the feasibility of a future scenario-driven electricity technology capacity expansion plan as generated by a parent model,

2) Site power plants in the least cost configuration when considering regional economics an on-the-ground barriers to siting,

3) Assist planners and modelers of alternate future realizations of the electricity system to gain an understanding of how siting costs and service area congestion may respond under certain stressors.


.. panels::
:card: + intro-card text-center
:column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex


---
:img-top: _static/index_getting_started.svg

Getting Started
^^^^^^^^^^^^^^^

New to **cerf**? Get familiar with what **cerf** is all about.

+++

.. link-button:: getting_started
:type: ref
:text: What CERF is all about
:classes: btn-block btn-secondary stretched-link

---
:img-top: _static/index_user_guide.svg

User Guide
^^^^^^^^^^

The user guide provides in-depth information on the
key concepts of **cerf**.

+++

.. link-button:: user_guide
:type: ref
:text: To the user guide
:classes: btn-block btn-secondary stretched-link

---
:img-top: _static/index_api.svg

API Reference
^^^^^^^^^^^^^

The reference guide contains a detailed description of
the **cerf** API. The reference describes how the methods
work and which parameters can be used.

+++

.. link-button:: cerf
:type: ref
:text: To the reference guide
:classes: btn-block btn-secondary stretched-link

---
:img-top: _static/index_contribute.svg

Contributing to CERF
^^^^^^^^^^^^^^^^^^^^

Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of improving **cerf**.

+++

.. link-button:: contributing
:type: ref
:text: To the development guide
:classes: btn-block btn-secondary stretched-link


.. toctree::
:maxdepth: 2
:hidden:

getting_started
user_guide
modules
contributing
release_notes
publications
how_to_cite
authors
license
footer
:notoc:

cerf documentation
==================

**Date**: |today| **Version**: |version|

**Useful links**:
`Source Repository <https://github.com/immm-sfa/cerf>`_ |
`Issues & Ideas <https://github.com/immm-sfa/cerf/issues>`_ |
`Interactive Quickstarter <quickstarter.rst>`_

**cerf** is an open-source geospatial Python package for evaluating and analyzing future electricity technology capacity expansion feasibility. **cerf** was created to evaluate the on-the-ground siting feasibility of an electricity system expansion plan by:

1) Translating a capacity expansion plan into individually sited renewable and non-renewable power plants across a region.

2) Emulating regional practices that address local congestion and interconnection costs as well as the social, land, and policy-based constraints faced by developers.

3) Providing a flexible and computationally efficient tool to understand the relative importance of different factors affecting the feasibility of siting new infrastructure, such as energy justice, land suitability, water availability, and emissions.

.. panels::
:card: + intro-card text-center
:column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex


---
:img-top: _static/index_getting_started.svg

Getting Started
^^^^^^^^^^^^^^^

New to **cerf**? Get familiar with what **cerf** is all about.

+++

.. link-button:: getting_started
:type: ref
:text: What CERF is all about
:classes: btn-block btn-secondary stretched-link

---
:img-top: _static/index_user_guide.svg

User Guide
^^^^^^^^^^

The user guide provides in-depth information on the
key concepts of **cerf**.

+++

.. link-button:: user_guide
:type: ref
:text: To the user guide
:classes: btn-block btn-secondary stretched-link

---
:img-top: _static/index_api.svg

API Reference
^^^^^^^^^^^^^

The reference guide contains a detailed description of
the **cerf** API. The reference describes how the methods
work and which parameters can be used.

+++

.. link-button:: cerf
:type: ref
:text: To the reference guide
:classes: btn-block btn-secondary stretched-link

---
:img-top: _static/index_contribute.svg

Contributing to CERF
^^^^^^^^^^^^^^^^^^^^

Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of improving **cerf**.

+++

.. link-button:: contributing
:type: ref
:text: To the development guide
:classes: btn-block btn-secondary stretched-link


.. toctree::
:maxdepth: 2
:hidden:

getting_started
user_guide
modules
contributing
release_notes
publications
how_to_cite
authors
license
footer

0 comments on commit 0354f04

Please sign in to comment.