Update dev with main hot fixes

.github/workflows/test_pvade.yaml

@@ -2,7 +2,8 @@ name: test_pvade
 
 on:
   push:
-    branches: [ main, dev ]
+    branches: [ main ]
+    # branches: [ main, dev ]
   pull_request:
     branches: [ main, dev ]
 

LICENSE.txt

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023 Alliance for Sustainable Energy, LLC
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -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
 

docs/technical_reference/domain_creation.rst

@@ -1,6 +1,22 @@
 DomainCreation
 ==============
 
-.. automodule:: pvade.geometry.template.TemplateDomainCreation
+.. automodule:: pvade.geometry.cylinder2d.DomainCreation
    :members:
-   :private-members:
+   :inherited-members:
+   :private-members:
+
+.. automodule:: pvade.geometry.cylinder3d.DomainCreation
+   :members:
+   :inherited-members:
+   :private-members:
+
+.. automodule:: pvade.geometry.panels2d.DomainCreation
+   :members:
+   :inherited-members:
+   :private-members:
+
+.. automodule:: pvade.geometry.panels3d.DomainCreation
+   :members:
+   :inherited-members:
+   :private-members:

docs/technical_reference/flow_manager.rst

@@ -1,6 +1,10 @@
 FlowManager
 ===========
 
-.. automodule:: pvade.FlowManager
+.. automodule:: pvade.fluid.FlowManager
+   :members:
+   :private-members:
+
+.. automodule:: pvade.fluid.boundary_conditions
    :members:
    :private-members:

docs/technical_reference/index.rst

@@ -6,9 +6,6 @@ Technical Reference
 
    parameters
    data_stream
-   domain_creation_panels
    domain_creation
    mesh_manager
-   mesh_manager_2d
-   mesh_manager_3d
    flow_manager

environment.yaml

@@ -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