From 6219d5abd8cfd51c801d86d45d2d3911ebbe8601 Mon Sep 17 00:00:00 2001 From: "David P. Chassin" Date: Fri, 2 Oct 2020 08:44:40 -0700 Subject: [PATCH 1/2] Add resources to docs header. --- docs/Resources.md | 25 +++++++++++++++++++++++++ docs/_header.md | 2 +- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/Resources.md diff --git a/docs/Resources.md b/docs/Resources.md new file mode 100644 index 000000000..d94207ccd --- /dev/null +++ b/docs/Resources.md @@ -0,0 +1,25 @@ +The following resources are available to GridLAB-D users. + +## [Models](https://github.com/slacgismo/gridlabd-models) + +This GitHub project contains numerous models used in the development, testing, and teaching of GridLAB-D. These models can also serve as examples of how to do some more exotic things using GridLAB-D. + +## [Templates](https://github.com/slacgismo/gridlabd-templates) + +This GitHub project contains GLM templates that can be configured using CSV inputs to perform specific analyses on models. See [[/Subcommand/Template]] for details. + +## [Converters](https://github.com/slacgismo/gridlabd-converters) + +This GitHub project contains converters that GridLAB-D uses to accept inputs or generate outputs of various formats. See [[/Converters/README]] for details. + +## [Weather](https://github.com/slacgismo/gridlabd-weather) + +This GitHub project contains weather data that can be accessed using the `weather` subcommand. See [[/Subcommand/Weather]] for details. + +## [Library](https://github.com/slacgismo/gridlabd-library) + +This GitHub project contains libraries of GLM object that can be used in GridLAB-D models. See [[/Subcommand/Library]] for details. + +## [Examples](https://github.com/slacgismo/gridlabd-examples) + +This GitHub project contains example GLM files that illustrate various ways of using GridLAB-D. diff --git a/docs/_header.md b/docs/_header.md index 8c64cc2c8..ec455f3f8 100644 --- a/docs/_header.md +++ b/docs/_header.md @@ -1,2 +1,2 @@ # [HiPAS GridLAB-D 4.2](http://www.gridlabd.us/) User Documentation -## ((Home)) ((Features)) ((Getting Started)) ((Documentation)) ((Developers)) ((Sponsors)) ((About Us)) ((News)) +## ((Home)) ((Features)) ((Getting Started)) ((Documentation)) ((Resources)) ((Developers)) ((Sponsors)) ((About Us)) ((News)) From 7a1dffb0e251ab522f9c1521580106be444e10d3 Mon Sep 17 00:00:00 2001 From: "David P. Chassin" Date: Fri, 2 Oct 2020 08:44:50 -0700 Subject: [PATCH 2/2] Add resources to develop docs --- docs/Developers.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/Developers.md b/docs/Developers.md index 369318290..1bc67c75b 100644 --- a/docs/Developers.md +++ b/docs/Developers.md @@ -1,5 +1,14 @@ Software developers and engineers are welcome to contribute to HiPAS GridLAB-D. The source code to HiPAS is available to the public through the [GitHub SLAC Gismo GridLAB-D project](https://github.com/slacgismo/gridlabd). +## Developer Resources + + - [Source code](https://github.com/slacgismo/gridlabd) + - [Issues](https://github.com/slacgismo/gridlabd/issues) + - [Pull requests](https://github.com/slacgismo/gridlabd/pulls) + - [Projects](https://github.com/slacgismo/gridlabd/projects) + - [Wiki](https://github.com/slacgismo/gridlabd) + - [Team Discussions](https://github.com/slacgismo/teams/gridlab-d/discussions) + Developers should consult the [[/Developer/README]] for information about modifying and contributing to HiPAS GridLAB-D. # Installing HiPAS GridLAB-D from source code