Skip to content

Commit 123bb94

Browse files
authored
Update landing page info (#4)
1 parent 43ae6f4 commit 123bb94

File tree

8 files changed

+126
-34
lines changed

8 files changed

+126
-34
lines changed

.github/workflows/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@
44

55
Runs on push, this action runs our perl script in `buildsystem/tools/file_naming_conventions.pl` to enforce certain name restrictions defined in our developer guidelines (P003). We use one action to checkout the code, then another to install perl before running the script.
66

7-
## `ornl_ascent_mirror.yaml`
8-
9-
This pushes to a GitLab at ORNL and runs CI/CD on Ascent. This also can re-build modules for testing newer versions of ExaGO and it's dependencies without needing to monitor builds by hand.
10-
11-
## `pnnl_mirror.yaml`
12-
13-
Similar to `ornl_ascent_mirror.yaml`, this mirrors to PNNL GitLab, but also supports Incline, Decpeption and Newell.
14-
157
## `pre_commit.yaml`
168

179
This enforces and runs pre-commit, and automatically commits fixes to any tests that it can. Noteably applies clang formatting, and cmake formatting most often, and requires developers to either install locally, or rebase to incorporate changes.
Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
1-
This folder contains deprecated workflow configurations, such as mirroring to other computing facilities.
2-
We are keeping these around as a starting point if similar workflows need to be setup in the future, but they will require some tinkering.
1+
This folder contains deprecated workflow configurations, such as
2+
mirroring to other computing facilities. We are keeping these around
3+
as a starting point if similar workflows need to be setup in the future,
4+
but they will require some tinkering.
5+
6+
7+
## `ornl_ascent_mirror.yaml`
8+
9+
This pushes to a GitLab at ORNL and runs CI/CD on Ascent. This also can re-build
10+
modules for testing newer versions of ExaGO and it's dependencies without needing
11+
to monitor builds by hand.
12+
13+
## `pnnl_mirror.yaml`
14+
15+
Similar to `ornl_ascent_mirror.yaml`, this mirrors to PNNL GitLab, but also supports
16+
Incline, Decpeption and Newell.

.github/workflows/spack_cpu_build.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Spack Ubunutu x86_64 Buildcache
33

44
env:
55
SPACK_COLOR: always
6-
REGISTRY: ghcr.io/pnnl
6+
REGISTRY: ghcr.io/ornl
77
# Our repo name contains upper case characters, so we can't use ${{ github.repository }}
88
IMAGE_NAME: exago
99
USERNAME: exago-bot

LICENSE

Lines changed: 44 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,46 @@
1-
Copyright (c) 2020, Battelle Memorial Institute
1+
Copyright (c) 2026, UT-Battelle.
2+
All rights reserved.
23

3-
1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter “the Software”) to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions:
4-
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
5-
- 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.
6-
- Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form whatsoever without the express written consent of Battelle.
7-
2. 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 BATTELLE 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.
4+
ExaGO™ version 2
85

9-
This license DOES NOT apply to any third-party libraries used. Those libraries are covered by their own license.
6+
7+
Open Source License:
8+
9+
Subject to the conditions of this License, UT-Battelle, LLC, hereby grants
10+
free of charge, to any person obtaining a copy of this software and associated
11+
documentation files (the "Software"), a perpetual, worldwide, non-exclusive,
12+
no-charge, royalty-free, irrevocable copyright license to use, copy, modify,
13+
merge, publish, distribute, and/or sublicense copies of the Software.
14+
15+
1. Redistributions of Software must retain the above open source license grant,
16+
copyright and license notices, this list of conditions, and the disclaimer
17+
listed below. Changes or modifications to, or derivative works of the
18+
Software must be noted with comments and the contributor and organization's
19+
name. If the Software is protected by a proprietary trademark owned by
20+
UT-Battelle, LLC or the Department of Energy, then derivative works of the
21+
Software may not be distributed using the trademark without the prior written
22+
approval of the trademark owner.
23+
24+
2. Neither the names of Licensor nor the Department of Energy may be used to
25+
endorse or promote products derived from this Software without their specific
26+
prior written permission.
27+
28+
3. The Software, with or without modification, must include the following
29+
acknowledgment: "This product includes software produced by UT-Battelle, LLC
30+
under Contract No. DE-AC05-00OR22725 with the Department of Energy.”
31+
32+
33+
34+
-------------------------------------------------------------------------------
35+
36+
DISCLAIMER:
37+
38+
UT-BATTELLE, LLC, AND THE GOVERNMENT MAKE NO REPRESENTATIONS AND DISCLAIM ALL
39+
WARRANTIES, BOTH EXPRESSED AND IMPLIED. THERE ARE NO EXPRESS OR IMPLIED
40+
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE
41+
USE OF THE SOFTWARE WILL NOT INFRINGE ANY PATENT, COPYRIGHT, TRADEMARK, OR
42+
OTHER PROPRIETARY RIGHTS, OR THAT THE SOFTWARE WILL ACCOMPLISH THE INTENDED
43+
RESULTS OR THAT THE SOFTWARE OR ITS USE WILL NOT RESULT IN INJURY OR DAMAGE.
44+
THE USER ASSUMES RESPONSIBILITY FOR ALL LIABILITIES, PENALTIES, FINES, CLAIMS,
45+
CAUSES OF ACTION, AND COSTS AND EXPENSES, CAUSED BY, RESULTING FROM OR ARISING
46+
OUT OF, IN WHOLE OR IN PART THE USE, STORAGE OR DISPOSAL OF THE SOFTWARE.

LICENSE-1.6.0

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Copyright (c) 2020, Battelle Memorial Institute
2+
3+
1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter “the Software”) to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions:
4+
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.
5+
- 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.
6+
- Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form whatsoever without the express written consent of Battelle.
7+
2. 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 BATTELLE 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.
8+
9+
This license DOES NOT apply to any third-party libraries used. Those libraries are covered by their own license.

NOTICE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Disclaimer:
2+
3+
This material was prepared as an account of work sponsored by an agency of the
4+
United States Government. Neither the United States Government nor the United
5+
States Department of Energy, nor UT-Battelle, nor any of their employees, nor
6+
any jurisdiction or organization that has cooperated in the development of
7+
these materials, makes any warranty, express or implied, or assumes any legal
8+
liability or responsibility for the accuracy, completeness, or usefulness or
9+
any information, apparatus, product, software, or process disclosed, or
10+
represents that its use would not infringe privately owned rights.
11+
12+
Reference herein to any specific commercial product, process, or service by
13+
trade name, trademark, manufacturer, or otherwise does not necessarily
14+
constitute or imply its endorsement, recommendation, or favoring by the United
15+
States Government or any agency thereof, or UT Batelle. The views and opinions
16+
of authors expressed herein do not necessarily state or reflect those of the
17+
United States Government or any agency thereof.
18+
19+
OAK RIDGE NATIONAL LABORATORY
20+
operated by UT-BATTELLE for the
21+
UNITED STATES DEPARTMENT OF ENERGY
22+
under Contract DE-AC05-00OR22725

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# <b>Exa</b>scale <b>G</b>rid <b>O</b>ptimization toolkit (ExaGO<sup>TM</sup>) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) ![PNNL GitLab Push Mirror](https://github.com/pnnl/ExaGO/actions/workflows/pnnl_mirror.yaml/badge.svg) ![ORNL Ascent GitLab Push Mirror](https://github.com/pnnl/ExaGO/actions/workflows/ornl_ascent_mirror.yaml/badge.svg) ![pre-commit GitHub Action](https://github.com/pnnl/ExaGO/actions/workflows/pre_commit.yaml/badge.svg?event=pull_request) ![Spack CPU Build](https://github.com/pnnl/ExaGO/actions/workflows/spack_cpu_build.yaml/badge.svg?event=pull_request)
1+
# <b>Exa</b>scale <b>G</b>rid <b>O</b>ptimization toolkit (ExaGO<sup>TM</sup>) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) ![pre-commit GitHub Action](https://github.com/ornl/ExaGO/actions/workflows/pre_commit.yaml/badge.svg?event=pull_request) ![Spack CPU Build](https://github.com/ornl/ExaGO/actions/workflows/spack_cpu_build.yaml/badge.svg?event=pull_request)
22

33
<!--![](viz/images/network_gen_load_us.png)-->
44
<img src="viz/images/network_gen_load_us.png">
@@ -64,7 +64,8 @@ Instructions for executing the different ExaGO<sup>TM</sup> applications is give
6464
- [SCOPFLOW](docs/web/scopflow.md)
6565
- [PFLOW](docs/web/pflow.md)
6666

67-
We also provide our user manual as a pdf [manual.pdf](docs/manual/manual.pdf) -> need to update this regularly with CI / move to quarto docs.
67+
We also provide our user manual as a pdf [manual.pdf](docs/manual/manual.pdf)
68+
-> need to update this regularly with CI / move to quarto docs.
6869

6970
## Tutorials
7071

@@ -79,7 +80,9 @@ We also provide our user manual as a pdf [manual.pdf](docs/manual/manual.pdf) ->
7980

8081
### Options
8182

82-
Each application has a different set of options that are described in depth in the usage notes. These options can be passed optionally through an options file (`-optionsfile <option_file>`), or directly on the command line.
83+
Each application has a different set of options that are described in depth in
84+
the usage notes. These options can be passed optionally through an options file
85+
(`-optionsfile <option_file>`), or directly on the command line.
8386

8487
Since options may be specified in more than one location (on the command line, and through an options file), it is worth noting that the option specified on the command line supersede those in the options file. For example, if `opflowoptions` options file set the network file via the option `-netfile case9mod.m`, the following behavior occurs:
8588

@@ -92,35 +95,50 @@ Since options may be specified in more than one location (on the command line, a
9295
```
9396

9497
## Visualization (experimental)
95-
ExaGO has an experimental visualization to display the results of `OPFLOW` application on a map. See the [visualization README](viz/README.md) for more information.
98+
ExaGO has an experimental visualization to display the results of `OPFLOW`
99+
application on a map. See the [visualization README](viz/README.md) for more
100+
information.
96101

97102
## Contributing
98103

99-
Please see [the developer guidelines](docs/developer_guidelines.md) before attempting to contribute.
100-
Feel free to raise an issue or contact the team if the guidelines are ambiguous or you have a particular question.
104+
Please see [the developer guidelines](docs/developer_guidelines.md) before
105+
attempting to contribute. Feel free to raise an issue or contact the team if
106+
the guidelines are ambiguous or you have a particular question.
101107

102108
## Authors
103-
- Shrirang Abhyankar
109+
ExaGO<sup>TM</sup> was designed and implemented by Shrirang Abhyankar. It has
110+
received significant from following developers:
104111
- Slaven Peles
112+
- Nicholson Koukpaizan
113+
- Maksudul Alam
105114
- Asher Mancinelli
106115
- Cameron Rutherford
116+
- Joshua Hambrick
117+
- Philip Fackler
118+
- Eve Tsybina
107119
- Bruce Palmer
108120
- Jaelyn Litzinger
109121
- William Perkins
110122
- Sayef Azad Sakin
111123
- Joseph Macam
112124
- Ryan Danehy
113-
- Nicholson Koukpaizan
114125

115126
## Acknowledgement
116-
This package is developed as a part of [ExaSGD](https://www.exascaleproject.org/research-project/exasgd/) project under the [Exascale computing project](https://www.exascaleproject.org/).
127+
ExaGO<sup>TM</sup> has been originally developed as a part of
128+
[ExaSGD](https://www.exascaleproject.org/research-project/exasgd/)
129+
project under the [Exascale computing project](https://www.exascaleproject.org/).
117130

118131
## Copyright
119-
Copyright &copy; 2020, Battelle Memorial Institute.
120132

121-
ExaGO<sup>TM</sup> is a free software distributed under a BSD 2-clause license. You may reuse, modify, and redistribute the software. See the [license](LICENSE) file for details.
133+
Copyright &copy; 2026, UT Battelle.
122134

135+
ExaGO<sup>TM</sup> (v2) is a free software distributed under a BSD-style
136+
license. See the [LICENSE](LICENSE) and [NOTICE](NOTICE) files for details.
137+
All new contributions to ExaGO<sup>TM</sup> must be made under the same
138+
licensing terms. ExaGO<sup>TM</sup> v2 contains code from ExaGO v1.6.0,
139+
licensed under 2-clause BSD [license](LICENSE-1.6.0).
123140

124-
## Disclaimer
125-
This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor Battelle, nor any of their employees, nor any jurisdiction or organization that has cooperated in the development of these materials, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness or any information, apparatus, product, software, or process disclosed, or represents that its use would not infringe privately owned rights.
126-
Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise does not necessarily constitute or imply its endorsement, recommendation, or favoring by the United States Government or any agency thereof, or Battelle Memorial Institute. The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof.
141+
Please Note If you are using ExaGO<sup>TM</sup> with any third party libraries
142+
linked in (e.g., CoinHSL), be sure to review the respective license of the
143+
package as that license may have more restrictive terms than the
144+
ExaGO<sup>TM</sup> license.

buildsystem/spack/spack_repo/exago/packages/exago/package.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ class Exago(CMakePackage, CudaPackage, ROCmPackage):
2525
problems on parallel and distributed architectures, particularly targeted
2626
for exascale machines."""
2727

28-
homepage = "https://github.com/pnnl/ExaGO"
29-
git = "https://github.com/pnnl/ExaGO.git"
28+
homepage = "https://github.com/ornl/ExaGO"
29+
git = "https://github.com/ornl/ExaGO.git"
3030
maintainers("ryandanehy", "cameronrutherford", "pelesh")
3131

3232
version(

0 commit comments

Comments
 (0)