From dc8b76e6ed6d6ee5eb8cbce296cee0ee5652fec7 Mon Sep 17 00:00:00 2001 From: John Siirola Date: Tue, 13 Jul 2021 07:40:43 -0600 Subject: [PATCH 1/4] Updating README formatting --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 484d6392..214f08c1 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Major features: * Generic handling of data across model formulations * Declarative model representation to support formulation development -EGRET is available under the BSD License (see LICENSE.txt) +EGRET is available under the BSD License (see [LICENSE.txt](https://github.com/grid-parity-exchange/Egret/blob/main/LICENSE.txt)) ### Installation @@ -20,7 +20,7 @@ EGRET is available under the BSD License (see LICENSE.txt) * Download (or clone) EGRET from this GitHub site. * From the main EGRET folder (i.e., the folder containing setup.py), use a terminal (or the Anaconda prompt for Windows users) to run setup.py to install EGRET into your Python installation - as follows: - pip install -e . + pip install -e . ### Requirements @@ -30,7 +30,7 @@ EGRET is available under the BSD License (see LICENSE.txt) We additionally recommend that EGRET users install the open source CBC MIP solver. The specific mechanics of installing CBC are platform-specific. When using Anaconda on Linux and Mac platforms, this can be accomplished simply by: - conda install -c conda-forge coincbc + conda install -c conda-forge coincbc The COIN-OR organization - who developers CBC - also provides pre-built binaries for a full range of platforms on https://bintray.com/coin-or/download. @@ -38,19 +38,20 @@ The COIN-OR organization - who developers CBC - also provides pre-built binaries To test the functionality of the unit commitment aspects of EGRET, execute the following command from the EGRET models/tests sub-directory: - pytest test_unit_commitment.py + pytest test_unit_commitment.py If EGRET can find a commerical MIP solver on your system via Pyomo, EGRET will execute a large test suite including solving several MIPs to optimality. If EGRET can only find an open-source solver, it will execute a more limited test suite which mostly relies on solving LP relaxations. Example output is below. -=================================== test session starts ==================================
-platform darwin -- Python 3.7.7, pytest-5.4.2, py-1.8.1, pluggy-0.13.0
-rootdir: /home/some-user/egret
-collected 21 items
-
-test_unit_commitment.py s.................... [100%]
-
-========================= 20 passed, 1 skipped in 641.80 seconds =========================
+``` +=================================== test session starts ================================== +platform darwin -- Python 3.7.7, pytest-5.4.2, py-1.8.1, pluggy-0.13.0 +rootdir: /home/some-user/egret +collected 21 items +test_unit_commitment.py s.................... [100%] + +========================= 20 passed, 1 skipped in 641.80 seconds ========================= +``` ### How to Cite EGRET in Your Research From 5e6e79afbba0403252bdbab9affaceb70fd67ed7 Mon Sep 17 00:00:00 2001 From: John Siirola Date: Tue, 13 Jul 2021 07:41:00 -0600 Subject: [PATCH 2/4] Adding a PR template --- .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..60a8431e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +## Fixes # . + +## Summary/Motivation: + + +## Changes proposed in this PR: +- +- + +### Legal Acknowledgement + +By contributing to this software project, I have read the [contribution guide](https://github.com/grid-parity-exchange/Egret/blob/main/CONTRIBUTING.md) and agree to the following terms and conditions for my contribution: + +1. I agree my contributions are submitted under the BSD license. +2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer. From b02a91e4d23227ffb43600a4aa79986b7188a7f6 Mon Sep 17 00:00:00 2001 From: John Siirola Date: Tue, 13 Jul 2021 07:41:55 -0600 Subject: [PATCH 3/4] Updating README formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 214f08c1..0dc8f4c6 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ EGRET is available under the BSD License (see [LICENSE.txt](https://github.com/g * Download (or clone) EGRET from this GitHub site. * From the main EGRET folder (i.e., the folder containing setup.py), use a terminal (or the Anaconda prompt for Windows users) to run setup.py to install EGRET into your Python installation - as follows: - pip install -e . + pip install -e . ### Requirements From 45ca6b2218f2a68b2dfcfd706a35a1027a11604f Mon Sep 17 00:00:00 2001 From: John Siirola Date: Tue, 13 Jul 2021 07:42:17 -0600 Subject: [PATCH 4/4] Updating README formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0dc8f4c6..211b8bfe 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ EGRET is available under the BSD License (see [LICENSE.txt](https://github.com/g * Download (or clone) EGRET from this GitHub site. * From the main EGRET folder (i.e., the folder containing setup.py), use a terminal (or the Anaconda prompt for Windows users) to run setup.py to install EGRET into your Python installation - as follows: - pip install -e . + pip install -e . ### Requirements