From 89c1ab45e28f834343ae236c1c52898d1080dc78 Mon Sep 17 00:00:00 2001 From: Young Date: Thu, 7 Dec 2023 13:43:20 -0700 Subject: [PATCH 1/9] update documentation link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c2e5a71f..c7e32a78 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## 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/index.html) guide which describes how to create the Conda environment and run the example simulations. ## Developer Quick Start From 3212a92c40ac6ac664ac2efee38412f685deec99 Mon Sep 17 00:00:00 2001 From: Young Date: Thu, 7 Dec 2023 13:50:28 -0700 Subject: [PATCH 2/9] pin to dolfinx 0.6 for now --- environment.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/environment.yaml b/environment.yaml index dd4adad9..f9c9310f 100644 --- a/environment.yaml +++ b/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 From 3c456e965f7e4fb0acf47ddc31a857a0e09389a3 Mon Sep 17 00:00:00 2001 From: Young Date: Thu, 7 Dec 2023 13:55:04 -0700 Subject: [PATCH 3/9] update links, add doc badge --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c7e32a78..9aaa952b 100644 --- a/README.md +++ b/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](https://pvade.readthedocs.io/en/latest/index.html) 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 From 755408e7f43c8ecf7cdac2b905779ccb209fdc8b Mon Sep 17 00:00:00 2001 From: Ethan Young Date: Thu, 7 Dec 2023 14:54:40 -0700 Subject: [PATCH 4/9] Create LICENSE --- LICENSE | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..917b93b1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +BSD 3-Clause License + +Copyright (c) 2023, National Renewable Energy Laboratory + +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. From 541f409fe342fc6a17cd20b707f602600d68b08c Mon Sep 17 00:00:00 2001 From: Young Date: Thu, 7 Dec 2023 14:57:04 -0700 Subject: [PATCH 5/9] removing old files and adding new hierarchy to existing files --- docs/technical_reference/domain_creation.rst | 20 +++++++++++++++++-- .../domain_creation_panels.rst | 6 ------ docs/technical_reference/flow_manager.rst | 6 +++++- docs/technical_reference/index.rst | 3 --- docs/technical_reference/mesh_manager_2d.rst | 6 ------ docs/technical_reference/mesh_manager_3d.rst | 6 ------ 6 files changed, 23 insertions(+), 24 deletions(-) delete mode 100644 docs/technical_reference/domain_creation_panels.rst delete mode 100644 docs/technical_reference/mesh_manager_2d.rst delete mode 100644 docs/technical_reference/mesh_manager_3d.rst diff --git a/docs/technical_reference/domain_creation.rst b/docs/technical_reference/domain_creation.rst index c0849cb3..73a4aa73 100644 --- a/docs/technical_reference/domain_creation.rst +++ b/docs/technical_reference/domain_creation.rst @@ -1,6 +1,22 @@ DomainCreation ============== -.. automodule:: pvade.geometry.template.TemplateDomainCreation +.. automodule:: pvade.geometry.cylinder2d.DomainCreation :members: - :private-members: \ No newline at end of file + :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: diff --git a/docs/technical_reference/domain_creation_panels.rst b/docs/technical_reference/domain_creation_panels.rst deleted file mode 100644 index 8c585df9..00000000 --- a/docs/technical_reference/domain_creation_panels.rst +++ /dev/null @@ -1,6 +0,0 @@ -DomainCreationPanels -==================== - -.. automodule:: pvade.geometry.panels.DomainCreation - :members: - :private-members: \ No newline at end of file diff --git a/docs/technical_reference/flow_manager.rst b/docs/technical_reference/flow_manager.rst index a9d0bb36..9a888b76 100644 --- a/docs/technical_reference/flow_manager.rst +++ b/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: \ No newline at end of file diff --git a/docs/technical_reference/index.rst b/docs/technical_reference/index.rst index e42a7a56..5105fe82 100644 --- a/docs/technical_reference/index.rst +++ b/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 diff --git a/docs/technical_reference/mesh_manager_2d.rst b/docs/technical_reference/mesh_manager_2d.rst deleted file mode 100644 index 8b6b2ad1..00000000 --- a/docs/technical_reference/mesh_manager_2d.rst +++ /dev/null @@ -1,6 +0,0 @@ -MeshManager2D -============= - -.. automodule:: pvade.geometry.MeshManager2d - :members: - :private-members: \ No newline at end of file diff --git a/docs/technical_reference/mesh_manager_3d.rst b/docs/technical_reference/mesh_manager_3d.rst deleted file mode 100644 index 4bafc60a..00000000 --- a/docs/technical_reference/mesh_manager_3d.rst +++ /dev/null @@ -1,6 +0,0 @@ -MeshManager3d -============= - -.. automodule:: pvade.geometry.MeshManager3d - :members: - :private-members: \ No newline at end of file From 28498d68d0567103140e78b2f1f3e1adac2119c6 Mon Sep 17 00:00:00 2001 From: Ethan Young Date: Fri, 8 Dec 2023 10:07:25 -0700 Subject: [PATCH 6/9] Update LICENSE --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 917b93b1..96aa19c6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2023, National Renewable Energy Laboratory +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: From 99933f6edcdb99f2e44cf89e58d629a3d1798ebb Mon Sep 17 00:00:00 2001 From: Ethan Young Date: Fri, 8 Dec 2023 10:08:44 -0700 Subject: [PATCH 7/9] Rename LICENSE to LICENSE.txt --- LICENSE => LICENSE.txt | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename LICENSE => LICENSE.txt (100%) diff --git a/LICENSE b/LICENSE.txt similarity index 100% rename from LICENSE rename to LICENSE.txt From 1cbeb4f6d33b78ac1c8d1b671661302c1e88b39b Mon Sep 17 00:00:00 2001 From: arswalid <39504093+arswalid@users.noreply.github.com> Date: Tue, 2 Jan 2024 10:23:04 -0700 Subject: [PATCH 8/9] Update test_pvade.yaml push to impact dev only --- .github/workflows/test_pvade.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test_pvade.yaml b/.github/workflows/test_pvade.yaml index 3a1fd2d7..43d4f7f4 100644 --- a/.github/workflows/test_pvade.yaml +++ b/.github/workflows/test_pvade.yaml @@ -2,7 +2,8 @@ name: test_pvade on: push: - branches: [ main, dev ] + branches: [ dev ] + # branches: [ main, dev ] pull_request: branches: [ main, dev ] From 2afb26d780601f1aa46d120b5691ef28d10e58a2 Mon Sep 17 00:00:00 2001 From: arswalid <39504093+arswalid@users.noreply.github.com> Date: Tue, 2 Jan 2024 10:35:20 -0700 Subject: [PATCH 9/9] Update test_pvade.yaml --- .github/workflows/test_pvade.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test_pvade.yaml b/.github/workflows/test_pvade.yaml index 43d4f7f4..599e3c72 100644 --- a/.github/workflows/test_pvade.yaml +++ b/.github/workflows/test_pvade.yaml @@ -2,7 +2,7 @@ name: test_pvade on: push: - branches: [ dev ] + branches: [ main ] # branches: [ main, dev ] pull_request: branches: [ main, dev ]