measur-tools-suite 1.0.11-beta.33 → 1.0.11-beta.35

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.
Files changed (4) hide show
  1. package/ROADMAP.md +18 -13
  2. package/bin/package.json +1 -1
  3. package/docs/mainpage.dox +50 -46
  4. package/package.json +1 -1
package/ROADMAP.md CHANGED
@@ -5,11 +5,10 @@ This document provides an overview of the refactoring and documentation efforts
5
5
  ## Tasks
6
6
 
7
7
  - [ ] Reorganize project directories to mirror the module structure
8
- - [ ] `Pumping System Assessments`
8
+ - [ ] `Compressed Air Assessments`
9
9
  - [ ] Create directory and migrate relevant files
10
10
  - [ ] Create associated namespace
11
- - [ ] Create `README.md` file to explain the purpose and functionality
12
- - [ ] `Process Heating Assessments`
11
+ - [ ] `Fan System Assessments`
13
12
  - [ ] Create directory and migrate relevant files
14
13
  - [ ] Create associated namespace
15
14
  - [ ] Create `README.md` file to explain the purpose and functionality
@@ -17,7 +16,11 @@ This document provides an overview of the refactoring and documentation efforts
17
16
  - [ ] Create directory and migrate relevant files
18
17
  - [ ] Create associated namespace
19
18
  - [ ] Create `README.md` file to explain the purpose and functionality
20
- - [ ] `Fan System Assessments`
19
+ - [ ] `Process Heating Assessments`
20
+ - [ ] Create directory and migrate relevant files
21
+ - [ ] Create associated namespace
22
+ - [ ] Create `README.md` file to explain the purpose and functionality
23
+ - [ ] `Pumping System Assessments`
21
24
  - [ ] Create directory and migrate relevant files
22
25
  - [ ] Create associated namespace
23
26
  - [ ] Create `README.md` file to explain the purpose and functionality
@@ -25,18 +28,19 @@ This document provides an overview of the refactoring and documentation efforts
25
28
  - [ ] Create directory and migrate relevant files
26
29
  - [ ] Create associated namespace
27
30
  - [ ] Create `README.md` file to explain the purpose and functionality
28
- - [ ] `Compressed Air Assessments`
31
+ - [ ] `Water Assessments`
29
32
  - [ ] Create directory and migrate relevant files
30
33
  - [ ] Create associated namespace
31
- - [ ] `Energy Treasure Hunt Module`
34
+ - [ ] Create `README.md` file to explain the purpose and functionality
35
+ - [ ] `Waste Water Assessments`
32
36
  - [ ] Create directory and migrate relevant files
33
37
  - [ ] Create associated namespace
34
38
  - [ ] Create `README.md` file to explain the purpose and functionality
35
- - [ ] `Simple Equipment and Property Calculators`
39
+ - [ ] `Energy Treasure Hunt Module`
36
40
  - [ ] Create directory and migrate relevant files
37
41
  - [ ] Create associated namespace
38
42
  - [ ] Create `README.md` file to explain the purpose and functionality
39
- - [ ] `Waste Water Assessments`
43
+ - [ ] `Simple Equipment and Property Calculators`
40
44
  - [ ] Create directory and migrate relevant files
41
45
  - [ ] Create associated namespace
42
46
  - [ ] Create `README.md` file to explain the purpose and functionality
@@ -46,9 +50,7 @@ This document provides an overview of the refactoring and documentation efforts
46
50
  - [ ] Move existing constants from various modules into `constants.h`
47
51
  - [ ] Update all modules to include `constants.h` where necessary
48
52
  - [ ] Document the purpose and usage of each constant in `constants.h`
49
- - [ ] Refactor & document `Pump System Assessments` module
50
- - [ ] Refactor & document `Process Heating Assessments` module
51
- - [ ] Refactor & document `Process Cooling Assessments` module
53
+ - [ ] Refactor & document `Compressed Air Assessments` module
52
54
  - [ ] Refactor & document `Fan System Assessments` module
53
55
  - [ ] Refactor & document `fan203.h`
54
56
  - [x] Rename header and associated source files to `fan203.h` and `fan203.cpp`
@@ -75,8 +77,11 @@ This document provides an overview of the refactoring and documentation efforts
75
77
  - [ ] Refactor & document `FlangePlane` class
76
78
  - [ ] Refactor & document `TraversePlane` class
77
79
  - [ ] Refactor & document `MstPlane` class
80
+ - [ ] Refactor & document `Process Cooling Assessments` module
81
+ - [ ] Refactor & document `Process Heating Assessments` module
82
+ - [ ] Refactor & document `Pumping System Assessments` module
78
83
  - [ ] Refactor & document `Steam System Assessments` module
79
- - [ ] Refactor & document `Compressed Air Assessments` module
84
+ - [ ] Refactor & document `Water Assessments` module
85
+ - [ ] Refactor & document `Waste Water Assessments` module
80
86
  - [ ] Refactor & document `Energy Treasure Hunt` module
81
87
  - [ ] Refactor & document `Simple Equipment and Property Calculators` module
82
- - [ ] Refactor & document `Waste Water Assessments` module
package/bin/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "measur-tools-suite",
3
- "version": "1.0.11-beta.33",
3
+ "version": "1.0.11-beta.35",
4
4
  "engines": {
5
5
  "node": "20.16.0",
6
6
  "npm": "10.8.1"
package/docs/mainpage.dox CHANGED
@@ -15,26 +15,39 @@
15
15
  * analysis alongside simple equipment and property calculators. Both the system assessment tools and the simple
16
16
  * calculators can be used as stand-alone tools for more focused analysis.
17
17
  *
18
- * - @ref PumpingSystemAssessments
19
- * - @ref ProcessHeatingAssessments
18
+ * - @ref CompressedAirAssessments
20
19
  * - @ref FanSystemAssessments
20
+ * - @ref ProcessCoolingAssessments
21
+ * - @ref ProcessHeatingAssessments
22
+ * - @ref PumpingSystemAssessments
21
23
  * - @ref SteamSystemAssessments
22
- * - @ref CompressedAirAssessments
24
+ * - @ref WaterAssessments
25
+ * - @ref WasteWaterAssessments
23
26
  * - @ref EnergyTreasureHuntModule
24
27
  * - @ref SimpleEquipmentAndPropertyCalculators
25
- * - @ref WasteWaterAssessments
26
- * - @ref WaterAssessments
27
- * - @ref ProcessCoolingAssessments
28
28
  *
29
- * @defgroup PumpingSystemAssessments Pumping System Assessments
29
+ * @defgroup CompressedAirAssessments Compressed Air Assessments
30
30
  *
31
- * This portion of MEASUR includes tools such as the Pump System Assessment Tool (PSAT) and related calculators.
32
- * MEASUR's pumping system tool helps evaluate the potential energy savings opportunities of pumping systems based on
33
- * field-measured data. The tool enables users to estimate system efficiency, energy use and cost, as well as create pump and system curves.
34
- * They are intended to help industrial users assess different system modifications
35
- * to determine which would be the most energetically beneficial. The what-if analysis helps users determine energy savings for different
36
- * potential energy efficiency measures or test the automatic optimizer functionality, built on curves from the Hydraulic Institute (HI) and motor performance data.
37
- * All MEASUR tools have extensive help text and the ability to share analyses with others.
31
+ * This portion of MEASUR includes tools such as AirMaster+ and related calculators. MEASUR includes a series of tools
32
+ * that help users analyze energy use and savings opportunities in industrial compressed air systems. They can baseline
33
+ * existing and model future system operations improvements, and evaluate energy and dollar savings from many energy
34
+ * efficiency measures.
35
+ *
36
+ * @defgroup FanSystemAssessments Fan System Assessments
37
+ *
38
+ * This portion of MEASUR includes tools such as the Fan System Assessment Tool (FSAT) and related calculators. This
39
+ * tool helps users identify and evaluate the potential energy savings opportunities in fan systems. Industrial users
40
+ * can assess various system modifications to determine optimal system configurations and allows users to test
41
+ * customized "what-if" operating scenarios to minimize energy consumption. Alternatively, users can utilize the
42
+ * automatic optimizer functionality which is built upon published fan efficiency data and motor performance data.
43
+ *
44
+ * @defgroup ProcessCoolingAssessments Process Cooling Assessments
45
+ *
46
+ * This portion of MEASUR includes tools such as the Chilled Water System Assessment (CWSA) tool and releated
47
+ * calculators. This tool helps users understand and evalute the potential energy savings opportunities of chillers and
48
+ * process cooling systems. Industrial users can better understand the current operating conditions of the components of
49
+ * a process cooling system, including chillers, cooling towers, and pumps. The tool helps estimate the year-round
50
+ * operating conditions and test "what-if" scenarios for various opportunities to reduce energy use.
38
51
  *
39
52
  * @defgroup ProcessHeatingAssessments Process Heating Assessments
40
53
  *
@@ -42,15 +55,18 @@
42
55
  * calculators. This tool introduces methods to improve thermal and electrical efficiency of process heating equipment.
43
56
  * Industrial users can survey process heating equipment consuming fuel or electricity, and identify the most
44
57
  * energy-intensive equipment. This tool can be used to perform a heat balance that identifies major areas of energy use
45
- * under various operating conditions and test "what-if" scenarios for various options to reduce energy use.
58
+ * under various operating conditions and test "what-if" scenarios for various options to reduce energy use.
46
59
  *
47
- * @defgroup FanSystemAssessments Fan System Assessments
60
+ * @defgroup PumpingSystemAssessments Pumping System Assessments
48
61
  *
49
- * This portion of MEASUR includes tools such as the Fan System Assessment Tool (FSAT) and related calculators. This
50
- * tool helps users identify and evaluate the potential energy savings opportunities in fan systems. Industrial users
51
- * can assess various system modifications to determine optimal system configurations and allows users to test
52
- * customized "what-if" operating scenarios to minimize energy consumption. Alternatively, users can utilize the
53
- * automatic optimizer functionality which is built upon published fan efficiency data and motor performance data.
62
+ * This portion of MEASUR includes tools such as the Pump System Assessment Tool (PSAT) and related calculators.
63
+ * MEASUR's pumping system tool helps evaluate the potential energy savings opportunities of pumping systems based on
64
+ * field-measured data. The tool enables users to estimate system efficiency, energy use and cost, as well as create
65
+ * pump and system curves. They are intended to help industrial users assess different system modifications to determine
66
+ * which would be the most energetically beneficial. The what-if analysis helps users determine energy savings for
67
+ * different potential energy efficiency measures or test the automatic optimizer functionality, built on curves from
68
+ * the Hydraulic Institute (HI) and motor performance data. All MEASUR tools have extensive help text and the ability to
69
+ * share analyses with others.
54
70
  *
55
71
  * @defgroup SteamSystemAssessments Steam System Assessments
56
72
  *
@@ -60,13 +76,22 @@
60
76
  * tool helps estimate the various steam flows throughout the system and test "what-if" scenarios for various
61
77
  * opportunities to reduce energy use.
62
78
  *
63
- * @defgroup CompressedAirAssessments Compressed Air Assessments
79
+ * @defgroup WaterAssessments Water Assessments
64
80
  *
65
- * This portion of MEASUR includes tools such as AirMaster+ and related calculators. MEASUR includes a series of tools
66
- * that help users analyze energy use and savings opportunities in industrial compressed air systems. They can baseline
67
- * existing and model future system operations improvements, and evaluate energy and dollar savings from many energy
81
+ * This portion of MEASUR includes tools such as the Plant Water Profiler (PWP) and the water diagram. This tool helps
82
+ * users create a water flow diagram and water balance, as well as calculate the true cost of water for a facility. This
83
+ * can help users identify systems that contribute the most toward water intake and the true cost to target for water
68
84
  * efficiency measures.
69
85
  *
86
+ * @defgroup WasteWaterAssessments Waste Water Assessments
87
+ *
88
+ * This portion of MEASUR includes tools such as the Bio-tiger wastewater model and related calculators. This tool helps
89
+ * users identify and evaluate the potential energy savings opportunities in the aeration stage of large-scale
90
+ * wastewater treatment systems. Industrial users can better understand the current oxygen requirements, supply, and
91
+ * aeration operating conditions of the system: the aeration tank and secondary clarifier. The tool helps understand the
92
+ * Monod kinetics and mass balances of the activated sludge process and test "what-if" scenarios for various
93
+ * opportunities to reduce energy use.
94
+ *
70
95
  * @defgroup EnergyTreasureHuntModule Energy Treasure Hunt Module
71
96
  *
72
97
  * MEASUR's Treasure Hunt is a collection of calculators that can be used in an energy Treasure Hunt or Energy Sweep
@@ -85,25 +110,4 @@
85
110
  * lighting systems. In addition, there are several general engineering calculators included to perform energy-related
86
111
  * calculations and conversions.
87
112
  *
88
- * @defgroup WasteWaterAssessments Waste Water Assessments
89
- *
90
- * This portion of MEASUR includes tools such as the Bio-tiger wastewater model and related calculators. This tool helps users identify
91
- * and evaluate the potential energy savings opportunities in the aeration stage of large-scale wastewater treatment systems.
92
- * Industrial users can better understand the current oxygen requirements, supply, and aeration operating conditions of the system: the aeration tank and secondary clarifier.
93
- * The tool helps understand the Monod kinetics and mass balances of the activated sludge process and test "what-if" scenarios for various
94
- * opportunities to reduce energy use.
95
- *
96
- * @defgroup WaterAssessments Water Assessments
97
- *
98
- * This portion of MEASUR includes tools such as the Plant Water Profiler (PWP) and the water diagram
99
- * This tool helps users create a water flow diagram and water balance, as well as calculate the true cost of water for a facility.
100
- * This can help users identify systems that contribute the most toward waster intake and the true cost to target for water efficiency measures.
101
- *
102
- * @defgroup ProcessCoolingAssessments Process Cooling Assessments
103
- *
104
- * This portion of MEASUR includes tools such as the Chilled Water System Assessment (CWSA) tool and releated calculators.
105
- * This tool helps users understand and evalute the potential energy savings opportunities of chillers and process cooling systems.
106
- * Industrial users can better understand the current operating conditions of the components of a process cooling system, including chillers, cooling towers, and pumps.
107
- * The tool helps estimate the year-round operating conditions and test "what-if" scenarios for various opportunities to reduce energy use.
108
- *
109
113
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "measur-tools-suite",
3
- "version": "1.0.11-beta.33",
3
+ "version": "1.0.11-beta.35",
4
4
  "engines": {
5
5
  "node": "20.16.0",
6
6
  "npm": "10.8.1"