primo-optimizer 0.1__tar.gz → 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of primo-optimizer might be problematic. Click here for more details.
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/LICENSE.md +39 -39
- primo_optimizer-0.2.0/PKG-INFO +211 -0
- primo_optimizer-0.2.0/README.md +93 -0
- primo_optimizer-0.2.0/primo/__init__.py +25 -0
- primo_optimizer-0.2.0/primo/data_parser/__init__.py +15 -0
- primo_optimizer-0.2.0/primo/data_parser/default_data.py +347 -0
- primo_optimizer-0.2.0/primo/data_parser/input_config.py +195 -0
- primo_optimizer-0.2.0/primo/data_parser/metric_data.py +714 -0
- primo_optimizer-0.2.0/primo/data_parser/tests/__init__.py +12 -0
- primo_optimizer-0.2.0/primo/data_parser/tests/test_metric_data.py +455 -0
- primo_optimizer-0.2.0/primo/data_parser/tests/test_well_data.py +782 -0
- primo_optimizer-0.2.0/primo/data_parser/tests/test_well_data_columns.py +210 -0
- primo_optimizer-0.2.0/primo/data_parser/tests/test_well_data_common_methods.py +405 -0
- primo_optimizer-0.2.0/primo/data_parser/well_data.py +1125 -0
- primo_optimizer-0.2.0/primo/data_parser/well_data_columns.py +173 -0
- primo_optimizer-0.2.0/primo/demo/tests/__init__.py +23 -0
- primo_optimizer-0.2.0/primo/demo/tests/test_demo.py +33 -0
- primo_optimizer-0.2.0/primo/opt_model/__init__.py +16 -0
- primo_optimizer-0.2.0/primo/opt_model/model_options.py +381 -0
- primo_optimizer-0.2.0/primo/opt_model/model_with_clustering.py +603 -0
- primo_optimizer-0.2.0/primo/opt_model/result_parser.py +830 -0
- primo_optimizer-0.2.0/primo/opt_model/tests/__init__.py +15 -0
- primo_optimizer-0.2.0/primo/opt_model/tests/test_model_options.py +608 -0
- primo_optimizer-0.2.0/primo/opt_model/tests/test_result_parser.py +658 -0
- primo_optimizer-0.2.0/primo/utils/__init__.py +34 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/census_utils.py +602 -475
- primo_optimizer-0.2.0/primo/utils/clustering_utils.py +147 -0
- primo_optimizer-0.2.0/primo/utils/config_utils.py +1158 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/demo_utils.py +616 -614
- primo_optimizer-0.2.0/primo/utils/domain_validators.py +74 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/download_utils.py +80 -73
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/elevation_utils.py +241 -269
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/estimation_utils.py +348 -346
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/geo_utils.py +337 -335
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/kpi_utils.py +296 -269
- primo_optimizer-0.2.0/primo/utils/map_utils.py +402 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/multiple_scenario_util.py +102 -97
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/opt_utils.py +213 -165
- primo_optimizer-0.2.0/primo/utils/override_utils.py +366 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/proximity_utils.py +182 -180
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/raise_exception.py +42 -42
- primo_optimizer-0.2.0/primo/utils/setup_logger.py +89 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/solvers.py +141 -156
- primo_optimizer-0.2.0/primo/utils/tests/__init__.py +12 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/test_census_utils.py +79 -92
- primo_optimizer-0.2.0/primo/utils/tests/test_clustering_utils.py +177 -0
- primo_optimizer-0.2.0/primo/utils/tests/test_config_utils.py +536 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/test_demo_utils.py +406 -422
- primo_optimizer-0.2.0/primo/utils/tests/test_domain_validators.py +44 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/test_estimation_utils.py +389 -388
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/test_geo_utils.py +49 -47
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/test_headers.py +90 -71
- primo_optimizer-0.2.0/primo/utils/tests/test_imports.py +15 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/test_kpi_utils.py +214 -213
- primo_optimizer-0.2.0/primo/utils/tests/test_logger.py +32 -0
- primo_optimizer-0.2.0/primo/utils/tests/test_map_utils.py +227 -0
- primo_optimizer-0.2.0/primo/utils/tests/test_opt_utils.py +84 -0
- primo_optimizer-0.2.0/primo/utils/tests/test_override_utils.py +333 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/test_proximity_utils.py +72 -71
- primo_optimizer-0.1/primo/utils/tests/test_elevation_utils.py → primo_optimizer-0.2.0/primo/utils/tests/test_secrets.py +160 -152
- primo_optimizer-0.2.0/primo/utils/tests/test_solvers.py +44 -0
- primo_optimizer-0.2.0/primo_optimizer.egg-info/PKG-INFO +211 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo_optimizer.egg-info/SOURCES.txt +26 -9
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo_optimizer.egg-info/requires.txt +10 -2
- primo_optimizer-0.2.0/pyproject.toml +129 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/setup.cfg +4 -4
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/stagedfright.py +370 -367
- primo_optimizer-0.1/PKG-INFO +0 -68
- primo_optimizer-0.1/README.md +0 -58
- primo_optimizer-0.1/primo/__init__.py +0 -13
- primo_optimizer-0.1/primo/data_parser/__init__.py +0 -10
- primo_optimizer-0.1/primo/data_parser/data_model.py +0 -197
- primo_optimizer-0.1/primo/data_parser/input_parser.py +0 -161
- primo_optimizer-0.1/primo/opt_model/__init__.py +0 -13
- primo_optimizer-0.1/primo/opt_model/base_model.py +0 -188
- primo_optimizer-0.1/primo/opt_model/opt_model.py +0 -583
- primo_optimizer-0.1/primo/opt_model/tests/__init__.py +0 -13
- primo_optimizer-0.1/primo/opt_model/tests/test_base_model.py +0 -120
- primo_optimizer-0.1/primo/opt_model/tests/test_opt_model.py +0 -137
- primo_optimizer-0.1/primo/utils/__init__.py +0 -40
- primo_optimizer-0.1/primo/utils/clustering_utils.py +0 -111
- primo_optimizer-0.1/primo/utils/config_utils.py +0 -518
- primo_optimizer-0.1/primo/utils/map_utils.py +0 -536
- primo_optimizer-0.1/primo/utils/setup_arg_parser.py +0 -144
- primo_optimizer-0.1/primo/utils/setup_logger.py +0 -86
- primo_optimizer-0.1/primo/utils/tests/__init__.py +0 -10
- primo_optimizer-0.1/primo/utils/tests/test_clustering_utils.py +0 -142
- primo_optimizer-0.1/primo/utils/tests/test_config_utils.py +0 -111
- primo_optimizer-0.1/primo/utils/tests/test_imports.py +0 -12
- primo_optimizer-0.1/primo/utils/tests/test_map_utils.py +0 -574
- primo_optimizer-0.1/primo_optimizer.egg-info/PKG-INFO +0 -68
- primo_optimizer-0.1/setup.py +0 -136
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo/utils/tests/weights_toy_example.xlsx +0 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo_optimizer.egg-info/dependency_links.txt +0 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo_optimizer.egg-info/entry_points.txt +0 -0
- {primo_optimizer-0.1 → primo_optimizer-0.2.0}/primo_optimizer.egg-info/top_level.txt +0 -0
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
License
|
|
2
|
-
=======
|
|
3
|
-
|
|
4
|
-
PRIMO - The P&A Project Optimizer Toolkit Copyright (c) 2023---2026, by the software owners: KeyLogic Systems, LLC.
|
|
5
|
-
All rights reserved.
|
|
6
|
-
|
|
7
|
-
Redistribution and use in source and binary forms, with or without
|
|
8
|
-
modification, are permitted provided that the following conditions are met:
|
|
9
|
-
|
|
10
|
-
1. Redistributions of source code must retain the above copyright notice, this
|
|
11
|
-
list of conditions and the following disclaimer.
|
|
12
|
-
|
|
13
|
-
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
14
|
-
this list of conditions and the following disclaimer in the documentation
|
|
15
|
-
and/or other materials provided with the distribution.
|
|
16
|
-
|
|
17
|
-
3. Neither the name of the U.S. Dept. of Energy, National Energy Technology Laboratory, KeyLogic Systems, LLC, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
18
|
-
|
|
19
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
20
|
-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
21
|
-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
22
|
-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
23
|
-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
24
|
-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
25
|
-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
26
|
-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
27
|
-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
28
|
-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
29
|
-
|
|
30
|
-
You are under no obligation whatsoever to provide any bug fixes, patches, or
|
|
31
|
-
upgrades to the features, functionality or performance of the source code
|
|
32
|
-
("Enhancements") to anyone; however, if you choose to make your Enhancements
|
|
33
|
-
available either publicly, or directly to National Energy Technology Laboratory,
|
|
34
|
-
or directly to KeyLogic Systems, LLC, without imposing a separate written license
|
|
35
|
-
agreement for such Enhancements, then you hereby grant National Energy Technology Laboratory
|
|
36
|
-
and KeyLogic Systems, LLC the following license: a non-exclusive, royalty-free perpetual
|
|
37
|
-
license to install, use, modify, prepare derivative works, incorporate into other computer software,
|
|
38
|
-
distribute, and sublicense such enhancements or derivative works thereof, in
|
|
39
|
-
binary and source code form.
|
|
1
|
+
License
|
|
2
|
+
=======
|
|
3
|
+
|
|
4
|
+
PRIMO - The P&A Project Optimizer Toolkit Copyright (c) 2023---2026, by the software owners: KeyLogic Systems, LLC.
|
|
5
|
+
All rights reserved.
|
|
6
|
+
|
|
7
|
+
Redistribution and use in source and binary forms, with or without
|
|
8
|
+
modification, are permitted provided that the following conditions are met:
|
|
9
|
+
|
|
10
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
11
|
+
list of conditions and the following disclaimer.
|
|
12
|
+
|
|
13
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
14
|
+
this list of conditions and the following disclaimer in the documentation
|
|
15
|
+
and/or other materials provided with the distribution.
|
|
16
|
+
|
|
17
|
+
3. Neither the name of the U.S. Dept. of Energy, National Energy Technology Laboratory, KeyLogic Systems, LLC, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
18
|
+
|
|
19
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
20
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
21
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
22
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
23
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
24
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
25
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
26
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
27
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
28
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
29
|
+
|
|
30
|
+
You are under no obligation whatsoever to provide any bug fixes, patches, or
|
|
31
|
+
upgrades to the features, functionality or performance of the source code
|
|
32
|
+
("Enhancements") to anyone; however, if you choose to make your Enhancements
|
|
33
|
+
available either publicly, or directly to National Energy Technology Laboratory,
|
|
34
|
+
or directly to KeyLogic Systems, LLC, without imposing a separate written license
|
|
35
|
+
agreement for such Enhancements, then you hereby grant National Energy Technology Laboratory
|
|
36
|
+
and KeyLogic Systems, LLC the following license: a non-exclusive, royalty-free perpetual
|
|
37
|
+
license to install, use, modify, prepare derivative works, incorporate into other computer software,
|
|
38
|
+
distribute, and sublicense such enhancements or derivative works thereof, in
|
|
39
|
+
binary and source code form.
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: primo-optimizer
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: PRIMO - The P&A Project Optimizer
|
|
5
|
+
Author-email: PRIMO team <primo@netl.doe.gov>
|
|
6
|
+
Maintainer-email: PRIMO team <primo@netl.doe.gov>
|
|
7
|
+
License: License
|
|
8
|
+
=======
|
|
9
|
+
|
|
10
|
+
PRIMO - The P&A Project Optimizer Toolkit Copyright (c) 2023---2026, by the software owners: KeyLogic Systems, LLC.
|
|
11
|
+
All rights reserved.
|
|
12
|
+
|
|
13
|
+
Redistribution and use in source and binary forms, with or without
|
|
14
|
+
modification, are permitted provided that the following conditions are met:
|
|
15
|
+
|
|
16
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
17
|
+
list of conditions and the following disclaimer.
|
|
18
|
+
|
|
19
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
20
|
+
this list of conditions and the following disclaimer in the documentation
|
|
21
|
+
and/or other materials provided with the distribution.
|
|
22
|
+
|
|
23
|
+
3. Neither the name of the U.S. Dept. of Energy, National Energy Technology Laboratory, KeyLogic Systems, LLC, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
24
|
+
|
|
25
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
26
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
27
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
28
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
29
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
30
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
31
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
32
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
33
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
34
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
35
|
+
|
|
36
|
+
You are under no obligation whatsoever to provide any bug fixes, patches, or
|
|
37
|
+
upgrades to the features, functionality or performance of the source code
|
|
38
|
+
("Enhancements") to anyone; however, if you choose to make your Enhancements
|
|
39
|
+
available either publicly, or directly to National Energy Technology Laboratory,
|
|
40
|
+
or directly to KeyLogic Systems, LLC, without imposing a separate written license
|
|
41
|
+
agreement for such Enhancements, then you hereby grant National Energy Technology Laboratory
|
|
42
|
+
and KeyLogic Systems, LLC the following license: a non-exclusive, royalty-free perpetual
|
|
43
|
+
license to install, use, modify, prepare derivative works, incorporate into other computer software,
|
|
44
|
+
distribute, and sublicense such enhancements or derivative works thereof, in
|
|
45
|
+
binary and source code form.
|
|
46
|
+
|
|
47
|
+
Project-URL: Documentation, https://primo.readthedocs.io/en/latest/
|
|
48
|
+
Project-URL: Download, https://github.com/NEMRI-org/primo-optimizer/releases
|
|
49
|
+
Project-URL: Homepage, https://edx.netl.doe.gov/nemri/
|
|
50
|
+
Project-URL: Source, https://github.com/NEMRI-org/primo-optimizer
|
|
51
|
+
Project-URL: Tracker, https://github.com/NEMRI-org/primo-optimizer/issues
|
|
52
|
+
Keywords: PRIMO,MERP,NEMRI,methane emissions,optimization,process modeling,operations research,well plugging
|
|
53
|
+
Platform: windows
|
|
54
|
+
Platform: linux
|
|
55
|
+
Classifier: Development Status :: 3 - Alpha
|
|
56
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
57
|
+
Classifier: Intended Audience :: Science/Research
|
|
58
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
59
|
+
Classifier: Natural Language :: English
|
|
60
|
+
Classifier: Operating System :: MacOS
|
|
61
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
62
|
+
Classifier: Operating System :: POSIX
|
|
63
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
64
|
+
Classifier: Operating System :: Unix
|
|
65
|
+
Classifier: Programming Language :: Python
|
|
66
|
+
Classifier: Programming Language :: Python :: 3
|
|
67
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
68
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
69
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
70
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
71
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
72
|
+
Classifier: Topic :: Scientific/Engineering :: Mathematics
|
|
73
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
74
|
+
Requires-Python: <3.12,>=3.9
|
|
75
|
+
Description-Content-Type: text/markdown
|
|
76
|
+
License-File: LICENSE.md
|
|
77
|
+
Requires-Dist: appengine-python-standard
|
|
78
|
+
Requires-Dist: censusgeocode
|
|
79
|
+
Requires-Dist: folium
|
|
80
|
+
Requires-Dist: geopandas
|
|
81
|
+
Requires-Dist: highspy
|
|
82
|
+
Requires-Dist: haversine
|
|
83
|
+
Requires-Dist: ipyfilechooser
|
|
84
|
+
Requires-Dist: ipyleaflet
|
|
85
|
+
Requires-Dist: ipywidgets
|
|
86
|
+
Requires-Dist: kneed
|
|
87
|
+
Requires-Dist: matplotlib
|
|
88
|
+
Requires-Dist: notebook
|
|
89
|
+
Requires-Dist: numpy
|
|
90
|
+
Requires-Dist: openpyxl
|
|
91
|
+
Requires-Dist: pandas
|
|
92
|
+
Requires-Dist: pyarrow
|
|
93
|
+
Requires-Dist: pyomo
|
|
94
|
+
Requires-Dist: pyscipopt
|
|
95
|
+
Requires-Dist: python-dotenv
|
|
96
|
+
Requires-Dist: scikit-learn
|
|
97
|
+
Requires-Dist: rasterio
|
|
98
|
+
Requires-Dist: xlsxwriter
|
|
99
|
+
Provides-Extra: dev
|
|
100
|
+
Requires-Dist: addheader; extra == "dev"
|
|
101
|
+
Requires-Dist: black; extra == "dev"
|
|
102
|
+
Requires-Dist: isort; extra == "dev"
|
|
103
|
+
Requires-Dist: linkify-it-py; extra == "dev"
|
|
104
|
+
Requires-Dist: myst-parser; extra == "dev"
|
|
105
|
+
Requires-Dist: nbsphinx; extra == "dev"
|
|
106
|
+
Requires-Dist: pre-commit; extra == "dev"
|
|
107
|
+
Requires-Dist: pylint; extra == "dev"
|
|
108
|
+
Requires-Dist: sphinx; extra == "dev"
|
|
109
|
+
Requires-Dist: sphinxcontrib-spelling; extra == "dev"
|
|
110
|
+
Requires-Dist: sphinx-rtd-theme; extra == "dev"
|
|
111
|
+
Provides-Extra: test
|
|
112
|
+
Requires-Dist: pytest; extra == "test"
|
|
113
|
+
Requires-Dist: pytest-cov; extra == "test"
|
|
114
|
+
Requires-Dist: pytest-ipywidgets[notebook]; extra == "test"
|
|
115
|
+
Requires-Dist: pytest-playwright; extra == "test"
|
|
116
|
+
Provides-Extra: gurobi
|
|
117
|
+
Requires-Dist: gurobipy; extra == "gurobi"
|
|
118
|
+
|
|
119
|
+
<!--  -->
|
|
120
|
+
<img src="docs/_static/logo-print-hd.jpg" width="400px" alg="PRIMO logo"></img>
|
|
121
|
+
|
|
122
|
+
# PRIMO - The P&A Project Optimizer Toolkit
|
|
123
|
+
|
|
124
|
+
PRIMO - The P&A Project Optimizer Toolkit aims to provide multi-scale, simulation-based, open source
|
|
125
|
+
computational tools and models to support the Methane Emissions Reduction Program (MERP) and the National
|
|
126
|
+
Emissions Reduction Initiative (NEMRI).
|
|
127
|
+
|
|
128
|
+
## Project Status
|
|
129
|
+
[](https://pypi.org/project/primo-optimizer/)
|
|
130
|
+
[](https://pypi.org/project/primo-optimizer/)
|
|
131
|
+
[](https://github.com/NEMRI-org/primo-optimizer/actions/workflows/checks.yml)
|
|
132
|
+
[](https://codecov.io/gh/NEMRI-org/primo-optimizer)
|
|
133
|
+
[](https://github.com/psf/black)
|
|
134
|
+
[](https://pycqa.github.io/isort/)
|
|
135
|
+
[](https://primo.readthedocs.io/en/latest/?badge=latest)
|
|
136
|
+
[](https://github.com/NEMRI-org/primo-optimizer/contributors)
|
|
137
|
+
[](https://github.com/NEMRI-org/primo-optimizer/pulls?q=is:pr+is:merged)
|
|
138
|
+
[](https://isitmaintained.com/project/NEMRI-org/primo-optimizer)
|
|
139
|
+
[](https://pepy.tech/project/primo-optimizer)
|
|
140
|
+
|
|
141
|
+
## Getting Started
|
|
142
|
+
|
|
143
|
+
Our complete documentation is available on [readthedocs](https://primo.readthedocs.io/en/latest/), but here is a summarized set of steps to get started using the framework.
|
|
144
|
+
|
|
145
|
+
While not required, we encourage the installation of [Anaconda](https://www.anaconda.com/products/individual#Downloads) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) and using the `conda` command to create a separate python environment in which to install the PRIMO Toolkit.
|
|
146
|
+
|
|
147
|
+
Regular users can use conda to create a new "primo" environment.
|
|
148
|
+
```bash
|
|
149
|
+
conda env create -f conda-env.yml
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
This creates a new conda environment with the name "primo" that comes installed with all required dependencies to solve PRIMO's optimization problems.
|
|
153
|
+
|
|
154
|
+
Developers can create a new "primo" environment by executing:
|
|
155
|
+
```bash
|
|
156
|
+
conda env create -f conda-env-dev.yml
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Activate the new environment with:
|
|
160
|
+
```bash
|
|
161
|
+
conda activate primo
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
Additionally, developers should complete the installation of the [playwright](https://playwright.dev/python/docs/intro) package which is required
|
|
165
|
+
for running tests.
|
|
166
|
+
```bash
|
|
167
|
+
playwright install
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
To test the installation of the primo package, execute:
|
|
171
|
+
```
|
|
172
|
+
pytest primo\utils\tests\test_imports.py
|
|
173
|
+
```
|
|
174
|
+
The above test, if executed successfully, confirms that primo package is now installed and available in the "primo" package that was just created.
|
|
175
|
+
|
|
176
|
+
To use the utilities implemented in the PRIMO package that query the U.S. Census API and Bing Maps API, appropriate API keys must be obtained
|
|
177
|
+
by signing up with the respective services. These keys must be configured in a .env file in the parent directory. For more details, please see:
|
|
178
|
+
[API Keys](https://primo.readthedocs.io/en/latest/method/api_keys.html)
|
|
179
|
+
|
|
180
|
+
Additionally, use of [elevation based utilities](https://primo.readthedocs.io/en/latest/Utilities/elevation_utils.html) requires the user to provide a GeoTIFF file that provides elevation data across the region of interest. Users can download this data from [USGS Science Data Catalog](https://data.usgs.gov/datacatalog/data/USGS:35f9c4d4-b113-4c8d-8691-47c428c29a5b). For more details, please see:
|
|
181
|
+
[Elevation Data]((https://primo.readthedocs.io/en/latest/method/elevation.html))
|
|
182
|
+
|
|
183
|
+
Users can also employ other commercial solvers, for example Gurobi, to solve the optimization problem.
|
|
184
|
+
However, users are responsible for configuring and setting up these solvers themselves.
|
|
185
|
+
|
|
186
|
+
General, background and overview information is available at the [NEMRI website](https://edx.netl.doe.gov/nemri/).
|
|
187
|
+
|
|
188
|
+
## Running PRIMO with Binder
|
|
189
|
+
|
|
190
|
+
You can run PRIMO with [Binder](https://mybinder.org): a public cloud service that provides a temporary and short-lived sandbox environment to run PRIMO without installing any software locally.
|
|
191
|
+
|
|
192
|
+
### Quickstart
|
|
193
|
+
|
|
194
|
+
You can launch the Binder environment by clicking on the following badge: [](https://mybinder.org/v2/gh/NEMRI-org/primo-optimizer/main?labpath=primo%2Fdemo%2F)
|
|
195
|
+
|
|
196
|
+
### Key Notes
|
|
197
|
+
|
|
198
|
+
* Binder environments are automatically destroyed after a [few minutes of inactivity](https://mybinder.readthedocs.io/en/latest/about/user-guidelines.html#how-long-will-my-binder-session-last). To avoid lost work, please download the notebook file on your local machine periodically.
|
|
199
|
+
* The Binder provided environment is **public and insecure**. Please do not use this environment to work with sensitive data.
|
|
200
|
+
|
|
201
|
+
## Funding acknowledgements
|
|
202
|
+
|
|
203
|
+
This work was conducted as part of the [National Emissions Reduction Initiative](https://edx.netl.doe.gov/nemri/)
|
|
204
|
+
with support through the [Environmental Protection Agency - Methane Emissions Reduction Program](https://www.epa.gov/inflation-reduction-act/methane-emissions-reduction-program)
|
|
205
|
+
within the U.S. Department of Energy’s [Office of Fossil Energy and Carbon Management (FECM)](https://www.energy.gov/fecm/office-fossil-energy-and-carbon-management).
|
|
206
|
+
As of 2023, additional support was provided by FECM’s [Solid Oxide Fuel Cell Program](https://www.energy.gov/fecm/science-innovation/clean-coal-research/solid-oxide-fuel-cells),
|
|
207
|
+
and [Transformative Power Generation Program](https://www.energy.gov/fecm/science-innovation/office-clean-coal-and-carbon-management/advanced-energy-systems/transformative).
|
|
208
|
+
|
|
209
|
+
## Contributing
|
|
210
|
+
|
|
211
|
+
**By contributing to this repository, you are agreeing to all the terms set out in the LICENSE.md and COPYRIGHT.md files in this directory.**
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
<!--  -->
|
|
2
|
+
<img src="docs/_static/logo-print-hd.jpg" width="400px" alg="PRIMO logo"></img>
|
|
3
|
+
|
|
4
|
+
# PRIMO - The P&A Project Optimizer Toolkit
|
|
5
|
+
|
|
6
|
+
PRIMO - The P&A Project Optimizer Toolkit aims to provide multi-scale, simulation-based, open source
|
|
7
|
+
computational tools and models to support the Methane Emissions Reduction Program (MERP) and the National
|
|
8
|
+
Emissions Reduction Initiative (NEMRI).
|
|
9
|
+
|
|
10
|
+
## Project Status
|
|
11
|
+
[](https://pypi.org/project/primo-optimizer/)
|
|
12
|
+
[](https://pypi.org/project/primo-optimizer/)
|
|
13
|
+
[](https://github.com/NEMRI-org/primo-optimizer/actions/workflows/checks.yml)
|
|
14
|
+
[](https://codecov.io/gh/NEMRI-org/primo-optimizer)
|
|
15
|
+
[](https://github.com/psf/black)
|
|
16
|
+
[](https://pycqa.github.io/isort/)
|
|
17
|
+
[](https://primo.readthedocs.io/en/latest/?badge=latest)
|
|
18
|
+
[](https://github.com/NEMRI-org/primo-optimizer/contributors)
|
|
19
|
+
[](https://github.com/NEMRI-org/primo-optimizer/pulls?q=is:pr+is:merged)
|
|
20
|
+
[](https://isitmaintained.com/project/NEMRI-org/primo-optimizer)
|
|
21
|
+
[](https://pepy.tech/project/primo-optimizer)
|
|
22
|
+
|
|
23
|
+
## Getting Started
|
|
24
|
+
|
|
25
|
+
Our complete documentation is available on [readthedocs](https://primo.readthedocs.io/en/latest/), but here is a summarized set of steps to get started using the framework.
|
|
26
|
+
|
|
27
|
+
While not required, we encourage the installation of [Anaconda](https://www.anaconda.com/products/individual#Downloads) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) and using the `conda` command to create a separate python environment in which to install the PRIMO Toolkit.
|
|
28
|
+
|
|
29
|
+
Regular users can use conda to create a new "primo" environment.
|
|
30
|
+
```bash
|
|
31
|
+
conda env create -f conda-env.yml
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
This creates a new conda environment with the name "primo" that comes installed with all required dependencies to solve PRIMO's optimization problems.
|
|
35
|
+
|
|
36
|
+
Developers can create a new "primo" environment by executing:
|
|
37
|
+
```bash
|
|
38
|
+
conda env create -f conda-env-dev.yml
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Activate the new environment with:
|
|
42
|
+
```bash
|
|
43
|
+
conda activate primo
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Additionally, developers should complete the installation of the [playwright](https://playwright.dev/python/docs/intro) package which is required
|
|
47
|
+
for running tests.
|
|
48
|
+
```bash
|
|
49
|
+
playwright install
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
To test the installation of the primo package, execute:
|
|
53
|
+
```
|
|
54
|
+
pytest primo\utils\tests\test_imports.py
|
|
55
|
+
```
|
|
56
|
+
The above test, if executed successfully, confirms that primo package is now installed and available in the "primo" package that was just created.
|
|
57
|
+
|
|
58
|
+
To use the utilities implemented in the PRIMO package that query the U.S. Census API and Bing Maps API, appropriate API keys must be obtained
|
|
59
|
+
by signing up with the respective services. These keys must be configured in a .env file in the parent directory. For more details, please see:
|
|
60
|
+
[API Keys](https://primo.readthedocs.io/en/latest/method/api_keys.html)
|
|
61
|
+
|
|
62
|
+
Additionally, use of [elevation based utilities](https://primo.readthedocs.io/en/latest/Utilities/elevation_utils.html) requires the user to provide a GeoTIFF file that provides elevation data across the region of interest. Users can download this data from [USGS Science Data Catalog](https://data.usgs.gov/datacatalog/data/USGS:35f9c4d4-b113-4c8d-8691-47c428c29a5b). For more details, please see:
|
|
63
|
+
[Elevation Data]((https://primo.readthedocs.io/en/latest/method/elevation.html))
|
|
64
|
+
|
|
65
|
+
Users can also employ other commercial solvers, for example Gurobi, to solve the optimization problem.
|
|
66
|
+
However, users are responsible for configuring and setting up these solvers themselves.
|
|
67
|
+
|
|
68
|
+
General, background and overview information is available at the [NEMRI website](https://edx.netl.doe.gov/nemri/).
|
|
69
|
+
|
|
70
|
+
## Running PRIMO with Binder
|
|
71
|
+
|
|
72
|
+
You can run PRIMO with [Binder](https://mybinder.org): a public cloud service that provides a temporary and short-lived sandbox environment to run PRIMO without installing any software locally.
|
|
73
|
+
|
|
74
|
+
### Quickstart
|
|
75
|
+
|
|
76
|
+
You can launch the Binder environment by clicking on the following badge: [](https://mybinder.org/v2/gh/NEMRI-org/primo-optimizer/main?labpath=primo%2Fdemo%2F)
|
|
77
|
+
|
|
78
|
+
### Key Notes
|
|
79
|
+
|
|
80
|
+
* Binder environments are automatically destroyed after a [few minutes of inactivity](https://mybinder.readthedocs.io/en/latest/about/user-guidelines.html#how-long-will-my-binder-session-last). To avoid lost work, please download the notebook file on your local machine periodically.
|
|
81
|
+
* The Binder provided environment is **public and insecure**. Please do not use this environment to work with sensitive data.
|
|
82
|
+
|
|
83
|
+
## Funding acknowledgements
|
|
84
|
+
|
|
85
|
+
This work was conducted as part of the [National Emissions Reduction Initiative](https://edx.netl.doe.gov/nemri/)
|
|
86
|
+
with support through the [Environmental Protection Agency - Methane Emissions Reduction Program](https://www.epa.gov/inflation-reduction-act/methane-emissions-reduction-program)
|
|
87
|
+
within the U.S. Department of Energy’s [Office of Fossil Energy and Carbon Management (FECM)](https://www.energy.gov/fecm/office-fossil-energy-and-carbon-management).
|
|
88
|
+
As of 2023, additional support was provided by FECM’s [Solid Oxide Fuel Cell Program](https://www.energy.gov/fecm/science-innovation/clean-coal-research/solid-oxide-fuel-cells),
|
|
89
|
+
and [Transformative Power Generation Program](https://www.energy.gov/fecm/science-innovation/office-clean-coal-and-carbon-management/advanced-energy-systems/transformative).
|
|
90
|
+
|
|
91
|
+
## Contributing
|
|
92
|
+
|
|
93
|
+
**By contributing to this repository, you are agreeing to all the terms set out in the LICENSE.md and COPYRIGHT.md files in this directory.**
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
#################################################################################
|
|
2
|
+
# PRIMO - The P&A Project Optimizer was produced under the Methane Emissions
|
|
3
|
+
# Reduction Program (MERP) and National Energy Technology Laboratory's (NETL)
|
|
4
|
+
# National Emissions Reduction Initiative (NEMRI).
|
|
5
|
+
#
|
|
6
|
+
# NOTICE. This Software was developed under funding from the U.S. Government
|
|
7
|
+
# and the U.S. Government consequently retains certain rights. As such, the
|
|
8
|
+
# U.S. Government has been granted for itself and others acting on its behalf
|
|
9
|
+
# a paid-up, nonexclusive, irrevocable, worldwide license in the Software to
|
|
10
|
+
# reproduce, distribute copies to the public, prepare derivative works, and
|
|
11
|
+
# perform publicly and display publicly, and to permit others to do so.
|
|
12
|
+
#################################################################################
|
|
13
|
+
|
|
14
|
+
# User-defined libs
|
|
15
|
+
from primo.data_parser.metric_data import EfficiencyMetrics, ImpactMetrics
|
|
16
|
+
from primo.data_parser.well_data import WellData
|
|
17
|
+
from primo.data_parser.well_data_columns import WellDataColumnNames
|
|
18
|
+
from primo.opt_model.model_options import OptModelInputs
|
|
19
|
+
from primo.opt_model.result_parser import EfficiencyCalculator, export_data_to_excel
|
|
20
|
+
from primo.utils import setup_logger
|
|
21
|
+
from primo.utils.config_utils import UserSelection
|
|
22
|
+
from primo.utils.override_utils import OverrideCampaign
|
|
23
|
+
|
|
24
|
+
RELEASE = "0.2.0"
|
|
25
|
+
VERSION = "0.2.0"
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
#################################################################################
|
|
2
|
+
# PRIMO - The P&A Project Optimizer was produced under the Methane Emissions
|
|
3
|
+
# Reduction Program (MERP) and National Energy Technology Laboratory's (NETL)
|
|
4
|
+
# National Emissions Reduction Initiative (NEMRI).
|
|
5
|
+
#
|
|
6
|
+
# NOTICE. This Software was developed under funding from the U.S. Government
|
|
7
|
+
# and the U.S. Government consequently retains certain rights. As such, the
|
|
8
|
+
# U.S. Government has been granted for itself and others acting on its behalf
|
|
9
|
+
# a paid-up, nonexclusive, irrevocable, worldwide license in the Software to
|
|
10
|
+
# reproduce, distribute copies to the public, prepare derivative works, and
|
|
11
|
+
# perform publicly and display publicly, and to permit others to do so.
|
|
12
|
+
#################################################################################
|
|
13
|
+
|
|
14
|
+
from .metric_data import EfficiencyMetrics, ImpactMetrics, Metric, SetOfMetrics
|
|
15
|
+
from .well_data_columns import WellDataColumnNames
|