Skip to content

Commit

Permalink
Merge pull request #31 from eyoung55/doc-update
Browse files Browse the repository at this point in the history
Update documentation links and content
  • Loading branch information
eyoung55 authored Dec 7, 2023
2 parents 99c8d59 + 3c456e9 commit 967676e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# PVade

`PVade` is an open source fluid-structure interaction model which can be used to study wind loading and stability on solar-tracking PV arrays. `PVade` can be used as part of a larger modeling chain to provide stressor inputs to mechanical module models to study the physics of failure for degradation mechanisms such as cell cracking, weathering of cracked cells, and glass breakage. For more information, visit the [PVade Documentation](TODO).
`PVade` is an open source fluid-structure interaction model which can be used to study wind loading and stability on solar-tracking PV arrays. `PVade` can be used as part of a larger modeling chain to provide stressor inputs to mechanical module models to study the physics of failure for degradation mechanisms such as cell cracking, weathering of cracked cells, and glass breakage. For more information, visit the [PVade Documentation](https://pvade.readthedocs.io/en/latest/index.html).

[![test_pvade](https://github.com/NREL/PVade/actions/workflows/test_pvade.yaml/badge.svg)](https://github.com/NREL/PVade/actions/workflows/test_pvade.yaml)
[![Documentation Status](https://readthedocs.org/projects/pvade/badge/?version=latest)](https://pvade.readthedocs.io/en/latest/?badge=latest)

## Getting Started

New users are encouraged to review the [Getting Started](TODO) guide which describes how to create the Conda environment and run the example simulations.
New users are encouraged to review the [Getting Started](https://pvade.readthedocs.io/en/latest/how_to_guides/getting_started.html) guide which describes how to create the Conda environment and run the example simulations.

## Developer Quick Start

Expand Down
2 changes: 1 addition & 1 deletion environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ dependencies:
# Dependencies should be kept as loosely pinned to version numbers as possible
- alive-progress
- black
- fenics-dolfinx
- fenics-dolfinx=0.6
- jsonschema
- jupyter
- matplotlib
Expand Down

0 comments on commit 967676e

Please sign in to comment.