ProFAST 1.0.3__tar.gz

profast-1.0.3/LICENSE

@@ -0,0 +1,31 @@
+END USER SOFTWARE LICENSE AGREEMENT 
+
+This License Agreement (“Agreement”) is between the Alliance for Sustainable Energy, LLC (“Alliance”),  the manager and operator of the National Renewable Energy Laboratory (“NREL”) for the U.S. Department of Energy (the “DOE”) and you (“Licensee”) hereinafter “Party” or collectively the “Parties.” By downloading, accessing, or using the Software described hereunder, you agree to be bound by the terms of this Agreement.
+
+IF YOU ARE ENTERING INTO THIS AGREEMENT WITHIN THE SCOPE OF YOUR EMPLOYMENT OR IN CONNECTION WITH YOUR ENGAGEMENT AS AN INDEPENDENT CONTRACTOR, THEN THE TERM “LICENSEE” INCLUDES YOUR EMPLOYER OR PRINCIPAL CONTRACTOR, AS APPLICABLE, AND YOU REPRESENT AND WARRANT TO ALLIANCE THAT YOU ARE AUTHORIZED TO ACCEPT THIS AGREEMENT ON SUCH EMPLOYER’S OR PRINCIPAL CONTRACTOR’S BEHALF.
+
+1.	License Grant.
+Alliance hereby grants Licensee a royalty-free, nonexclusive, nontransferable, limited license for the computer software program “ProFAST (Production Financial Analysis Scenario Tool)” (NREL Software Record no. SWR-23-88) in executable format, together with any documentation provided by Alliance which relates to its functional, operational or performance characteristics, as made available to Licensee via https://www.github.com/nrel/profast, and as modified from time to time (“Software”) to install, copy, and run the Software for noncommercial, internal research purposes only.   
+1.1.	Licensee may not disclose Software source code or any executable code generated therefrom to any third party. 
+1.2.	Licensee may not translate, decompile, reverse engineer, disassemble or otherwise attempt to create a human-readable version of the Software to the extent supplied in object code format. 
+1.3.	Any copies of the Software made by Licensee shall be subject to the terms of this Agreement.  
+1.4.	Alliance reserves and retains all rights, title, and other interests in the Software and any copies thereof, which are not explicitly granted to Licensee herein. 
+1.5.	Any copies of Software shall bear the following notice: 
+
+NOTICE
+
+Copyright © 2024 Alliance for Sustainable Energy, LLC, Inc. All Rights Reserved
+
+This computer software was produced by the Alliance for Sustainable Energy, LLC (Contractor) under Contract No. DE-AC36-08GO28308 with the U.S. Department of Energy (DOE). During the period of commercialization or such other time period specified by the DOE, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. Subsequent to that period the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to the Contractor or DOE. NEITHER THE UNITED STATES NOR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY DATA, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS.
+
+1.6.	Licensee agrees to credit the DOE, NREL, and Alliance in any publication or public presentation that results from use of the Software. However, the names of NREL, DOE, or Alliance may not be used to endorse or promote products derived from this software without specific prior written permission.
+1.7.	Alliance makes no guarantee of accessibility or ongoing availability of the Repository or of the Software. Alliance may revoke Licensee’s access or remove any or all portions of the Software from the Repository at any time and for any reason (or for no reason). Licensee agrees that Alliance has no obligation to provide access to the Repository or provide the Software.
+
+2. Maintenance or Support. Licensee assumes sole responsibility for the installation, use and results obtained from use of the Software. Alliance shall be under no obligation whatsoever to: (i) provide maintenance or support for Software; or (ii) to notify Licensee of bug fixes, patches, or upgrades to Software (if any).  If, in its sole discretion, Alliance makes a Software bug fix, patch or upgrade available to Licensee and Alliance does not separately enter into a written license agreement with Licensee relating to such bug fix, patch or upgrade, then it shall be deemed incorporated into the Software and subject to this Agreement.
+3. United States Government Rights. The Software was developed under funding from the DOE, and the United States Government retains certain rights as follows: For five (5) years after the date permission to assert copyright is obtained from the DOE, and during any subsequent five (5) year renewals, the United States Government is granted for itself and others acting on its behalf a non-exclusive, paid-up, irrevocable, worldwide license in the Software to reproduce, prepare derivative works, perform publicly and display publicly.   Subsequent to that period or any extension granted, the Government is granted for itself and others acting on its behalf, a nonexclusive, paid-up, irrevocable worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, perform publicly and display publicly, and to permit others to do so.  
+4. Warranty Disclaimer.  THE SOFTWARE IS SUPPLIED “AS IS” WITHOUT WARRANTY OF ANY KIND.  ALLIANCE, NREL, THE UNITED STATES GOVERNMENT, DOE, AND THEIR EMPLOYEES, OFFICERS AND AGENTS: (i) DISCLAIM ANY WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT, (ii) DO NOT ASSUME ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF SOFTWARE, (iii) DO NOT REPRESENT THAT USE OF SOFTWARE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS, AND (iv)  DO NOT WARRANT THAT THE OPERATION OF SOFTWARE WILL BE UNINTERRUPTED, THAT IT IS ERROR-FREE OR THAT ANY ERRORS WILL BE CORRECTED.
+5. Limitation of Liability. IN NO EVENT WILL ALLIANCE, NREL, DOE OR THE UNITED STATES GOVERNMENT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL OR PUNITIVE DAMAGES OF ANY KIND OR NATURE (INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, LOSS OF DATA, LOSS OF USE, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES OR BUSINESS INTERRUPTION) FOR ANY REASON WHATSOEVER, WHETHER SUCH LIABILITY IS ASSERTED ON THE BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE OR STRICT LIABILITY), OR OTHERWISE, EVEN IF ALLIANCE, NREL, DOE OR THE UNITED STATES GOVERNMENT IS MADE AWARE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGES. 
+6. Indemnity. Licensee shall indemnify, defend, and hold harmless Alliance, the DOE, the U.S. Government, and their agents, officers, and employees, against any and all claims, suits, losses, damage, costs, fees, and expenses arising out of or in connection with Licensee’s use of the Software pursuant to this Agreement.  Licensee shall pay all costs incurred by Alliance, the DOE and the U.S. Government in enforcing this provision, including reasonable attorney fees.  Licensee shall comply with all applicable laws and regulations (including privacy laws and regulations) having application to or governing its use and/or operation of the Software and agrees to indemnify and hold DOE, Alliance and the U.S. Government harmless from and against any claims, damages, losses or obligations suffered or incurred by Alliance directly or indirectly arising from its failure to so comply.  
+7. Term and Termination. The license granted to Licensee under this Agreement shall continue unless terminated earlier in accordance with this Agreement. Alliance shall have the right to terminate this license in its sole discretion at any time and for any reason (or for no reason) upon notice to Licensee.  If Licensee breaches any term of this Agreement, and fails to cure such breach within thirty (30) days of the date of written notice, this Agreement shall immediately terminate.  Licensee may terminate this Agreement without cause upon thirty (30) days written notice to Alliance.  Upon termination of the Agreement, Licensee shall immediately cease using the Software, destroy all copies of the Software, and provide Alliance with written certification of Licensee’s compliance with the foregoing.  Notwithstanding any provision of this Agreement to the contrary, Sections 1.5, 1.6, and 3 through 9 shall survive termination of this Agreement.
+8. Export Controls. Licensee shall observe all applicable United States and foreign laws and regulations (if any) with respect to the export, re-export, diversion or transfer of Software, related technical data and direct products thereof, including, without limitation, the Export Administration Regulations.
+9. General. This Agreement, and the rights and liabilities of the Parties with respect to this Agreement and its subject matter, shall be governed by the laws of the State of Colorado, without reference to the principles of conflicts of laws thereof.  Any dispute arising out of or relating to this Agreement or its subject matter not settled by the Parties may be resolved only by the courts of the State of Colorado, or if subject matter jurisdiction exists, by the United States federal courts, with venue in the County of Denver (in the case of state court) or in the U.S. District Court for the District of Colorado (in the case of federal court).  Each of the Parties hereby consents to the jurisdiction of such courts over it in any action involving any such dispute.  Each of the Parties agree not to commence or maintain a legal proceeding involving any such dispute in any forum except a court of the State of Colorado located in Denver County or the United States District Court for the District of Colorado (other than to enforce a judgment obtained in such courts) and agrees not to contest the venue of any action involving any such dispute in the County of Denver or the District of Colorado, as the case may be, nor to assert in any such court the doctrine of forum non conveniens, or the like. Any modification or amendment of this Agreement must be in writing signed by a duly authorized representative of each Party.  This Agreement is binding upon and shall inure to the benefit of Alliance, its successors and assignees and therefore may be assigned to a successor operator of NREL for the United States Government.  This Agreement represents the entire understanding of the Parties, and supersedes all previous communications, written or oral, relating to the subject of this Agreement.  This license does not constitute an endorsement of Licensee’s products and/or services, if any, and Licensee shall not use the names, logos or brands of Alliance, NREL or DOE without the express written consent of Alliance, or DOE as applicable.  If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms.    

profast-1.0.3/MANIFEST.in

@@ -0,0 +1,2 @@
+include ProFAST/pyc_files/*
+include ProFAST/resources/*

profast-1.0.3/NOTICE.txt

@@ -0,0 +1,3 @@
+NOTICE
+Copyright © 2023 Alliance for Sustainable Energy, LLC
+These data were produced by the Alliance for Sustainable Energy, LLC (Contractor) under Contract No. DE-AC36-08GO28308 with the U.S. Department of Energy (DOE). During the period of commercialization or such other time period specified by the DOE, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. Subsequent to that period the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to the Contractor or DOE. NEITHER CONTRACTOR, THE UNITED STATES, NOR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY DATA, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS.

profast-1.0.3/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.1
+Name: ProFAST
+Version: 1.0.3
+Summary: Production Financial Analysis Scenario Tool
+Author-email: Jamie Kee <Jamie.Kee@nrel.gov>, Michael Penev <Michael.Penev@nrel.gov>
+License: END USER SOFTWARE LICENSE AGREEMENT 
+        
+        This License Agreement (“Agreement”) is between the Alliance for Sustainable Energy, LLC (“Alliance”),  the manager and operator of the National Renewable Energy Laboratory (“NREL”) for the U.S. Department of Energy (the “DOE”) and you (“Licensee”) hereinafter “Party” or collectively the “Parties.” By downloading, accessing, or using the Software described hereunder, you agree to be bound by the terms of this Agreement.
+        
+        IF YOU ARE ENTERING INTO THIS AGREEMENT WITHIN THE SCOPE OF YOUR EMPLOYMENT OR IN CONNECTION WITH YOUR ENGAGEMENT AS AN INDEPENDENT CONTRACTOR, THEN THE TERM “LICENSEE” INCLUDES YOUR EMPLOYER OR PRINCIPAL CONTRACTOR, AS APPLICABLE, AND YOU REPRESENT AND WARRANT TO ALLIANCE THAT YOU ARE AUTHORIZED TO ACCEPT THIS AGREEMENT ON SUCH EMPLOYER’S OR PRINCIPAL CONTRACTOR’S BEHALF.
+        
+        1.	License Grant.
+        Alliance hereby grants Licensee a royalty-free, nonexclusive, nontransferable, limited license for the computer software program “ProFAST (Production Financial Analysis Scenario Tool)” (NREL Software Record no. SWR-23-88) in executable format, together with any documentation provided by Alliance which relates to its functional, operational or performance characteristics, as made available to Licensee via https://www.github.com/nrel/profast, and as modified from time to time (“Software”) to install, copy, and run the Software for noncommercial, internal research purposes only.   
+        1.1.	Licensee may not disclose Software source code or any executable code generated therefrom to any third party. 
+        1.2.	Licensee may not translate, decompile, reverse engineer, disassemble or otherwise attempt to create a human-readable version of the Software to the extent supplied in object code format. 
+        1.3.	Any copies of the Software made by Licensee shall be subject to the terms of this Agreement.  
+        1.4.	Alliance reserves and retains all rights, title, and other interests in the Software and any copies thereof, which are not explicitly granted to Licensee herein. 
+        1.5.	Any copies of Software shall bear the following notice: 
+        
+        NOTICE
+        
+        Copyright © 2024 Alliance for Sustainable Energy, LLC, Inc. All Rights Reserved
+        
+        This computer software was produced by the Alliance for Sustainable Energy, LLC (Contractor) under Contract No. DE-AC36-08GO28308 with the U.S. Department of Energy (DOE). During the period of commercialization or such other time period specified by the DOE, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. Subsequent to that period the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to the Contractor or DOE. NEITHER THE UNITED STATES NOR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY DATA, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS.
+        
+        1.6.	Licensee agrees to credit the DOE, NREL, and Alliance in any publication or public presentation that results from use of the Software. However, the names of NREL, DOE, or Alliance may not be used to endorse or promote products derived from this software without specific prior written permission.
+        1.7.	Alliance makes no guarantee of accessibility or ongoing availability of the Repository or of the Software. Alliance may revoke Licensee’s access or remove any or all portions of the Software from the Repository at any time and for any reason (or for no reason). Licensee agrees that Alliance has no obligation to provide access to the Repository or provide the Software.
+        
+        2. Maintenance or Support. Licensee assumes sole responsibility for the installation, use and results obtained from use of the Software. Alliance shall be under no obligation whatsoever to: (i) provide maintenance or support for Software; or (ii) to notify Licensee of bug fixes, patches, or upgrades to Software (if any).  If, in its sole discretion, Alliance makes a Software bug fix, patch or upgrade available to Licensee and Alliance does not separately enter into a written license agreement with Licensee relating to such bug fix, patch or upgrade, then it shall be deemed incorporated into the Software and subject to this Agreement.
+        3. United States Government Rights. The Software was developed under funding from the DOE, and the United States Government retains certain rights as follows: For five (5) years after the date permission to assert copyright is obtained from the DOE, and during any subsequent five (5) year renewals, the United States Government is granted for itself and others acting on its behalf a non-exclusive, paid-up, irrevocable, worldwide license in the Software to reproduce, prepare derivative works, perform publicly and display publicly.   Subsequent to that period or any extension granted, the Government is granted for itself and others acting on its behalf, a nonexclusive, paid-up, irrevocable worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, perform publicly and display publicly, and to permit others to do so.  
+        4. Warranty Disclaimer.  THE SOFTWARE IS SUPPLIED “AS IS” WITHOUT WARRANTY OF ANY KIND.  ALLIANCE, NREL, THE UNITED STATES GOVERNMENT, DOE, AND THEIR EMPLOYEES, OFFICERS AND AGENTS: (i) DISCLAIM ANY WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT, (ii) DO NOT ASSUME ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF SOFTWARE, (iii) DO NOT REPRESENT THAT USE OF SOFTWARE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS, AND (iv)  DO NOT WARRANT THAT THE OPERATION OF SOFTWARE WILL BE UNINTERRUPTED, THAT IT IS ERROR-FREE OR THAT ANY ERRORS WILL BE CORRECTED.
+        5. Limitation of Liability. IN NO EVENT WILL ALLIANCE, NREL, DOE OR THE UNITED STATES GOVERNMENT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL OR PUNITIVE DAMAGES OF ANY KIND OR NATURE (INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, LOSS OF DATA, LOSS OF USE, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES OR BUSINESS INTERRUPTION) FOR ANY REASON WHATSOEVER, WHETHER SUCH LIABILITY IS ASSERTED ON THE BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE OR STRICT LIABILITY), OR OTHERWISE, EVEN IF ALLIANCE, NREL, DOE OR THE UNITED STATES GOVERNMENT IS MADE AWARE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGES. 
+        6. Indemnity. Licensee shall indemnify, defend, and hold harmless Alliance, the DOE, the U.S. Government, and their agents, officers, and employees, against any and all claims, suits, losses, damage, costs, fees, and expenses arising out of or in connection with Licensee’s use of the Software pursuant to this Agreement.  Licensee shall pay all costs incurred by Alliance, the DOE and the U.S. Government in enforcing this provision, including reasonable attorney fees.  Licensee shall comply with all applicable laws and regulations (including privacy laws and regulations) having application to or governing its use and/or operation of the Software and agrees to indemnify and hold DOE, Alliance and the U.S. Government harmless from and against any claims, damages, losses or obligations suffered or incurred by Alliance directly or indirectly arising from its failure to so comply.  
+        7. Term and Termination. The license granted to Licensee under this Agreement shall continue unless terminated earlier in accordance with this Agreement. Alliance shall have the right to terminate this license in its sole discretion at any time and for any reason (or for no reason) upon notice to Licensee.  If Licensee breaches any term of this Agreement, and fails to cure such breach within thirty (30) days of the date of written notice, this Agreement shall immediately terminate.  Licensee may terminate this Agreement without cause upon thirty (30) days written notice to Alliance.  Upon termination of the Agreement, Licensee shall immediately cease using the Software, destroy all copies of the Software, and provide Alliance with written certification of Licensee’s compliance with the foregoing.  Notwithstanding any provision of this Agreement to the contrary, Sections 1.5, 1.6, and 3 through 9 shall survive termination of this Agreement.
+        8. Export Controls. Licensee shall observe all applicable United States and foreign laws and regulations (if any) with respect to the export, re-export, diversion or transfer of Software, related technical data and direct products thereof, including, without limitation, the Export Administration Regulations.
+        9. General. This Agreement, and the rights and liabilities of the Parties with respect to this Agreement and its subject matter, shall be governed by the laws of the State of Colorado, without reference to the principles of conflicts of laws thereof.  Any dispute arising out of or relating to this Agreement or its subject matter not settled by the Parties may be resolved only by the courts of the State of Colorado, or if subject matter jurisdiction exists, by the United States federal courts, with venue in the County of Denver (in the case of state court) or in the U.S. District Court for the District of Colorado (in the case of federal court).  Each of the Parties hereby consents to the jurisdiction of such courts over it in any action involving any such dispute.  Each of the Parties agree not to commence or maintain a legal proceeding involving any such dispute in any forum except a court of the State of Colorado located in Denver County or the United States District Court for the District of Colorado (other than to enforce a judgment obtained in such courts) and agrees not to contest the venue of any action involving any such dispute in the County of Denver or the District of Colorado, as the case may be, nor to assert in any such court the doctrine of forum non conveniens, or the like. Any modification or amendment of this Agreement must be in writing signed by a duly authorized representative of each Party.  This Agreement is binding upon and shall inure to the benefit of Alliance, its successors and assignees and therefore may be assigned to a successor operator of NREL for the United States Government.  This Agreement represents the entire understanding of the Parties, and supersedes all previous communications, written or oral, relating to the subject of this Agreement.  This license does not constitute an endorsement of Licensee’s products and/or services, if any, and Licensee shall not use the names, logos or brands of Alliance, NREL or DOE without the express written consent of Alliance, or DOE as applicable.  If any part of this Agreement is found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall remain valid and enforceable according to its terms.    
+        
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE.txt
+Requires-Dist: importlib_resources
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: numpy_financial
+Requires-Dist: pandas
+Requires-Dist: plotly
+Requires-Dist: pyarrow
+Requires-Dist: pytest
+Requires-Dist: xlwings
+
+# ProFAST
+The Production Financial Analysis Scenario Tool (ProFAST) is the python version of H2FAST. ProFAST provides a quick and convenient in-depth financial analysis for production systems and services based on Generally Accepted Accounting Principles (GAAP) methodology.
+
+Please see https://www.nrel.gov/hydrogen/h2fast.html for the H2FAST excel model
+
+<img src="https://www.nrel.gov/hydrogen/assets/images/h2fast-icon.png" alt="H2FAST Logo" style="width:200px;"/>
+
+# NOTICE
+[NOTICE.txt](NOTICE.txt)
+
+Copyright © 2023 Alliance for Sustainable Energy, LLC
+These data were produced by the Alliance for Sustainable Energy, LLC (Contractor) under Contract No. DE-AC36-08GO28308 with the U.S. Department of Energy (DOE). During the period of commercialization or such other time period specified by the DOE, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. Subsequent to that period the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to the Contractor or DOE. NEITHER CONTRACTOR, THE UNITED STATES, NOR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY DATA, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS.
+
+# LICENSE
+[LICENSE](LICENSE)
+
+# Citation
+Kee, Jamie, Penev, Michael, and USDOE Office of Energy Efficiency and Renewable Energy. ProFAST (Production Financial Analysis Scenario Tool) [SWR-23-88]. Computer software. USDOE Office of Energy Efficiency and Renewable Energy (EERE), Office of Sustainable Transportation. Hydrogen Fuel Cell Technologies Office (HFTO). 9 Nov. 2023. Web. doi:10.11578/dc.20231211.1.
+
+# Setup
+ProFAST can be installed using pip. Refer to [pyproject.toml](pyproject.toml) for configuration. ProFAST is installed as a compiled python file.
+
+## Installation
+`$ pip install .`
+
+## Testing
+`$ pytest`
+
+
+# Quick Start Example
+
+This quick start example is also in [generic_example.py](ProFAST/examples/generic_example.py) and can be accessed for exmaple usage.
+
+Start by importing the ProFAST class from the ProFAST package
+
+```python
+from ProFAST import ProFAST
+```
+
+Initialize a ProFAST instance
+
+```python
+pf = ProFAST()
+```
+
+Set parameter values for the financial model (you set some of them to 0 or not set them at all)
+```python
+# Define general inflation rate
+gen_inflation = 0.019
+
+#   Sales specification
+pf.set_params('commodity',{"name":'Hydrogen',"unit":"kg","initial price":4,"escalation":gen_inflation}) # Define the primary commodity
+pf.set_params('analysis start year',2025)
+pf.set_params('operating life',30) # Years of production
+pf.set_params('installation months',20) # Months of installation (no production)
+pf.set_params('demand rampup',2) # Years of ramp up (linear)
+pf.set_params('long term utilization',0.9) # The utilization or capacity factor of the plant, relative to the nameplate capacity
+
+# Installation information:
+pf.set_params('capacity',50000) #units/day # Nameplate capacity
+pf.set_params('installation cost',{"value":0,"depr type":"Straight line","depr period":5,"depreciable":False}) # Can be separated from capital items
+pf.set_params('non depr assets',10000) # Such as land
+pf.set_params('end of proj sale non depr assets',10000*(1+gen_inflation)**30) # Sale of land at project end
+pf.set_params('maintenance',{"value":5000,"escalation":gen_inflation}) # Annual maintenance cost
+
+#   Incentives specification
+pf.set_params('one time cap inct',{"value":250000,"depr type":"MACRS","depr period":5,"depreciable":False}) # Such as a capital grant, cost share, or investment tax credit 
+pf.set_params('annual operating incentive',{"value":1000,"decay":0,"sunset years":6,"taxable":True}) # Annual incentive (treated as income)
+pf.set_params('incidental revenue',{"value":500,"escalation":gen_inflation}) # Such as coffee sales
+
+#   Take or pay specification
+pf.set_params('TOPC',{"unit price":1,"decay":0.01,"support utilization":0.6,"sunset years":3}) # Underutilization support
+
+#   Other operating expenses
+pf.set_params('credit card fees',0.025) # Fraction of sales revenue
+pf.set_params('sales tax',0.023) # Fraction of sales revenue
+# pf.set_params('road tax',{"value":0,"escalation":0}) # Cost per unit of commodity ($/kg)
+pf.set_params('labor',{"value":20*40*52,"rate":20,"escalation":gen_inflation}) # 20 workers at 40hrs a week for 20$/hr
+pf.set_params('license and permit',{'value':2000,'escalation':gen_inflation}) # $/yr for licensing and permitting 
+pf.set_params('rent',{'value':50000,'escalation':gen_inflation}) # $/yr, for example for equipment
+pf.set_params('property tax and insurance',0.009) # Fraction of plant property and equipment
+pf.set_params('admin expense',0.005) # Fraction of sales revenue
+
+#   Financing information
+pf.set_params('total income tax rate',0.2574) # Combined tax rate
+pf.set_params('capital gains tax rate',0.15) # Only for any gains made on non depreciable assets
+pf.set_params('sell undepreciated cap',True)
+pf.set_params('tax losses monetized',True) # Offset coupled business tax liabilities
+pf.set_params('tax loss carry forward years',0) # If tax losses are carried forward
+pf.set_params('general inflation rate',gen_inflation) 
+pf.set_params('leverage after tax nominal discount rate',0.08) # Discount rate, and expected financial performance
+pf.set_params('debt equity ratio of initial financing',1.5) # D2E ratio at start
+pf.set_params('debt type','Revolving debt') # Bond/Revolving debt or one time loan
+pf.set_params('loan period if used',0) # Only for one time loan
+pf.set_params('debt interest rate',0.037) # Interest rate for loan
+pf.set_params('cash onhand',1) # Number of month of monthly expenses in liquidity
+```
+
+
+Set the feedstocks
+```python
+pf.add_feedstock(name='Water',usage=3.78,unit='gal',cost=0.005,escalation=gen_inflation) #3.78gal/kg H2
+pf.add_feedstock(name='Electricity (industrial)',usage=55.5,unit='kWh',cost=0.15,escalation=gen_inflation)
+```
+
+You can also use dictionaries and list to set the usages and costs
+```python
+years = list(map(str,range(2025-1,2025+30+2)))
+elec_usage = np.linspace(55.5,65,len(years))
+elec_usage_dict = dict(zip(years,elec_usage))
+pf.add_feedstock(name='Electricity (industrial) dict',usage=elec_usage_dict,unit='kWh',cost=0.15,escalation=gen_inflation)
+pf.remove_feedstock(name='Electricity (industrial) dict')
+```
+
+You can also use AEO feedstocks (Name and Cost must be valid values from AEO list)
+```python
+pf.edit_feedstock(name='Electricity (industrial)',value={'cost':'Mountain'})
+# AEO feedstocks can be modified for sensitivity analysis
+pf.edit_feedstock(name='Electricity (industrial)',value={'usage':55.5,'cost':'1.1X Mountain'})
+```
+
+Set the coproducts
+```python
+pf.add_coproduct(name='Oxygen',usage=7,unit='mol',cost=0.01,escalation=gen_inflation) 
+pf.edit_coproduct(name='Oxygen',value={'usage':7})
+```
+
+
+Set the capital items. These have a depreciation and a refurbishment schedule
+```python
+dol_per_kw = 500
+kW = 50000/24*55.5
+pf.add_capital_item(name='PEM Stack',cost=kW*dol_per_kw,depr_type='MACRS',depr_period=7,refurb=[0,0,0,0,0,0,0.15]*4) # Refurb 15% every 7 years
+pf.add_capital_item(name='BOP',cost=1000000,depr_type='MACRS',depr_period=7,refurb=[0])
+```
+
+
+Set the fixed costs. which is a annual cost
+```python
+pf.add_fixed_cost(name='Fixed costs',usage=1,unit='$',cost=3000000,escalation=gen_inflation)
+```
+
+Set the incentives, which is a per unit commodity based incentive
+```python
+pf.add_incentive(name='PTC',value=3,decay=0,sunset_years=10,tax_credit=True)
+```
+
+This solves for the break even price - access it with ``sol["price"]``
+
+```python
+sol = pf.solve_price()
+
+unit = pf.vals['commodity']['unit']
+name = pf.vals['commodity']['name']
+print('\n')
+print(f'Levelized cost of {name} price: ${round(sol["lco"],2)}/{unit}')
+print('\n')
+```
+
+Plot the cost breakdowns
+```python
+pf.plot_costs()
+```
+
+# Premade files
+Refer to the resources directory for premade JSON files to load in a ProFAST instance, where the input parameter is the filename. For example, to load in a sample [central grid electrolysis PEM](ProFAST/resources/central_grid_electrolysis_PEM.json)
+```python
+pf = ProFAST('central_grid_electrolysis_PEM')
+```
+

profast-1.0.3/ProFAST/__init__.py

@@ -0,0 +1,16 @@
+import sys
+
+version_info = sys.version_info
+major_versions = [3]
+minor_versions = [8,9,10,11]
+if version_info.major not in major_versions and version_info.minor not in minor_versions:
+    raise (ImportError(f"ProFAST is not currenly available for your Python version ({version_info[0]}.{version_info[1]}.{version_info[2]}). ProFAST is only compatible with Python 3.8, 3.9, 3.10, 3.11"))
+
+if version_info.minor == 8:
+    from .pyc_files.ProFAST_308 import ProFAST
+elif version_info.minor == 9:
+    from .pyc_files.ProFAST_309 import ProFAST
+elif version_info.minor == 10:
+    from .pyc_files.ProFAST_310 import ProFAST
+elif version_info.minor == 11:
+    from .pyc_files.ProFAST_311 import ProFAST

profast-1.0.3/ProFAST/examples/ProFAST_example.py

@@ -0,0 +1,98 @@
+
+def ProFAST_example():
+    """This function gives an example file to run ProFAST
+    :param None
+    :return None
+    """
+
+#   ProFAST example
+    import ProFAST
+    import time
+
+    #   Initialize ProFAST class
+    pf = ProFAST.ProFAST('central_wind_electrolysis')
+    # h2a = ProFAST.H2A_case('smr')
+
+    #  Premade JSON input files can also be loaded using the load_json functionality
+    pf.load_json('central_wind_electrolysis')
+
+    #   Add a feed stock
+    pf.add_feedstock(name='Residential electricity',usage=4,unit='kWh',cost=0.105427462,escalation=0.005)
+    #   Add a capital item
+    pf.add_capital_item(name='Compressor',cost=475286.1648,depr_type='MACRS',depr_period=5,refurb=[0.4401, 0.4401, 0.1011, 0.3871, 0.4686, 0.905 , 0.4024, 0.3172, 0.926 , 0.6936, 0.271 , 0     , 0     , 0     ])
+    #   Add a fixed cost
+    pf.add_fixed_cost(name='purity testing',usage=1,unit='$',cost=3483.816459,escalation=0.015246584)
+    #   Add a coproduct
+    pf.add_coproduct(name='Apples',usage=0.013394611,unit='bundles',cost=0.934823018,escalation=0.007012072)
+    #   Add an incentive
+    pf.add_incentive(name='LCFS',value=0.167811004,decay=0.00828,sunset_years=5,tax_credit=True)
+
+    #   Remove a feedstock
+    pf.remove_feedstock(name='Residential electricity')
+
+    #   Edit a coproduct
+    # pf.edit_coproduct('Apples',{'name':'Pears','usage':0.02})
+
+    #   Dictionary (year,value) pairs can be used to set the usage and cost metrics
+    years = list(map(str,range(1992,2100)))
+    juice_costs = [1]*len(years)
+    juice_cost_dict = dict(zip(years,juice_costs))
+    juice_usage_dict = dict(zip(years,[10]*len(years)))
+    pf.add_feedstock(name='juice',usage=juice_usage_dict,unit='barrels',cost=juice_cost_dict,escalation=2)
+
+    #   Timer
+    t1 = time.time()
+
+    #  Solve for the break-price
+    sol=pf.solve_price()
+
+    #   Print out break even price
+    price = sol['price']
+    irr = sol['irr']
+    ipp = sol['investor payback period']
+    lco = sol['lco']
+    print(f'First year price = {round(price,2)}')
+    print(f'Levelized cost = {round(lco,2)}')
+    print(f'IRR = {irr*100}%')
+    print(f'Investor payback period = {round(ipp,2)}')
+
+    #   Timer
+    t2 = time.time()
+    print(f'Time elapsed: {t2-t1}s')
+
+    #   Load defaults from json file (the default inputs are loaded by default)
+    pf.load_json('central_wind_electrolysis')
+
+    #   Change sales tax
+    # pf.set_params('sales tax',0.50)
+    sol=pf.solve_price()
+
+    #   Plot investor cash flow
+    pf.plot_cashflow()
+
+    #   Plot cost breakdown
+    pf.plot_costs()
+
+    #   Plot cost yearly breakdown
+    pf.plot_costs_yearly()
+
+    #   Plot cost yearly breakdown in plotly (interactive)
+    pf.plot_costs_yearly2()
+
+    #   Plot all time series in plotly (interactive)
+    pf.plot_time_series()
+
+    #   Solve for the break-price
+    sol=pf.solve_price()
+    price = sol['price']
+    irr = sol['irr']
+    ipp = sol['investor payback period']
+    lco = sol['lco']
+    print(f'First year price = {round(price,2)}')
+    print(f'Levelized cost = {round(lco,2)}')
+    print(f'IRR = {irr*100}%')
+    print(f'Investor payback period = {round(ipp,2)}')
+
+
+if __name__ == "__main__":
+    ProFAST_example()

profast-1.0.3/ProFAST/examples/generic_example.py

@@ -0,0 +1,156 @@
+import numpy as np
+import matplotlib.pyplot as plt
+
+
+def pf_setup():
+    # Import the ProFAST module
+    import ProFAST
+
+    # Create an ProFAST instance
+    pf = ProFAST.ProFAST() 
+
+    #
+    # Set the parameters
+    #
+
+    # Define general inflation rate
+    gen_inflation = 0.019
+
+    #   Sales specification
+    pf.set_params('commodity',{"name":'Hydrogen',"unit":"kg","initial price":4,"escalation":gen_inflation}) # Define the primary commodity
+    pf.set_params('analysis start year',2025)
+    pf.set_params('operating life',30) # Years of production
+    pf.set_params('installation months',20) # Months of installation (no production)
+    pf.set_params('demand rampup',2) # Years of ramp up (linear)
+    pf.set_params('long term utilization',0.9) # The utilization or capacity factor of the plant, relative to the nameplate capacity
+
+    # Installation information:
+    pf.set_params('capacity',50000) #units/day # Nameplate capacity
+    pf.set_params('installation cost',{"value":0,"depr type":"Straight line","depr period":5,"depreciable":False}) # Can be separated from capital items
+    pf.set_params('non depr assets',10000) # Such as land
+    pf.set_params('end of proj sale non depr assets',10000*(1+gen_inflation)**30) # Sale of land at project end
+    pf.set_params('maintenance',{"value":5000,"escalation":gen_inflation}) # Annual maintenance cost
+
+    #   Incentives specification
+    pf.set_params('one time cap inct',{"value":250000,"depr type":"MACRS","depr period":5,"depreciable":False}) # Such as a capital grant, cost share, or investment tax credit 
+    pf.set_params('annual operating incentive',{"value":1000,"decay":0,"sunset years":6,"taxable":True}) # Annual incentive (treated as income)
+    pf.set_params('incidental revenue',{"value":500,"escalation":gen_inflation}) # Such as coffee sales
+
+    #   Take or pay specification
+    pf.set_params('TOPC',{"unit price":1,"decay":0.01,"support utilization":0.6,"sunset years":3}) # Underutilization support
+
+    #   Other operating expenses
+    pf.set_params('credit card fees',0.025) # Fraction of sales revenue
+    pf.set_params('sales tax',0.023) # Fraction of sales revenue
+    # pf.set_params('road tax',{"value":0,"escalation":0}) # Cost per unit of commodity ($/kg)
+    pf.set_params('labor',{"value":20*40*52,"rate":20,"escalation":gen_inflation}) # 20 workers at 40hrs a week for 20$/hr
+    pf.set_params('license and permit',{'value':2000,'escalation':gen_inflation}) # $/yr for licensing and permitting 
+    pf.set_params('rent',{'value':50000,'escalation':gen_inflation}) # $/yr, for example for equipment
+    pf.set_params('property tax and insurance',0.009) # Fraction of plant property and equipment
+    pf.set_params('admin expense',0.005) # Fraction of sales revenue
+
+    #   Financing information
+    pf.set_params('total income tax rate',0.2574) # Combined tax rate
+    pf.set_params('capital gains tax rate',0.15) # Only for any gains made on non depreciable assets
+    pf.set_params('sell undepreciated cap',True)
+    pf.set_params('tax losses monetized',True) # Offset coupled business tax liabilities
+    pf.set_params('tax loss carry forward years',0) # If tax losses are carried forward
+    pf.set_params('general inflation rate',gen_inflation) 
+    pf.set_params('leverage after tax nominal discount rate',0.08) # Discount rate, and expected financial performance
+    pf.set_params('debt equity ratio of initial financing',1.5) # D2E ratio at start
+    pf.set_params('debt type','Revolving debt') # Bond/Revolving debt or one time loan
+    pf.set_params('loan period if used',0) # Only for one time loan
+    pf.set_params('debt interest rate',0.037) # Interest rate for loan
+    pf.set_params('cash onhand',1) # Number of month of monthly expenses in liquidity
+
+
+    #
+    # Set the feedstocks
+    #
+    pf.add_feedstock(name='Water',usage=3.78,unit='gal',cost=0.005,escalation=gen_inflation) #3.78gal/kg H2
+    pf.add_feedstock(name='Electricity (industrial)',usage=55.5,unit='kWh',cost=0.15,escalation=gen_inflation)
+
+    # You can also use dictionaries and list to set the usages and costs
+    years = list(map(str,range(2025-1,2025+30+2)))
+    elec_usage = np.linspace(55.5,65,len(years))
+    elec_usage_dict = dict(zip(years,elec_usage))
+    elec_cost_dict = dict(zip(years, [0.15,0.14,0.2,0.75] ))
+    pf.add_feedstock(name='Electricity (industrial) dict',usage=elec_usage_dict,unit='kWh',cost=0.15,escalation=gen_inflation)
+    pf.remove_feedstock(name='Electricity (industrial) dict')
+
+    # AEO feedstocks (Name and Cost must be valid values from AEO list)
+    pf.edit_feedstock(name='Electricity (industrial)',value={'cost':'Mountain'})
+    # AEO feedstocks can be modified for sensitivity analysis
+    pf.edit_feedstock(name='Electricity (industrial)',value={'usage':55.5,'cost':'1.1X Mountain'})
+
+    #
+    # Set the coproducts
+    #
+    pf.add_coproduct(name='Oxygen',usage=7,unit='mol',cost=0.01,escalation=gen_inflation) 
+    pf.edit_coproduct(name='Oxygen',value={'usage':7})
+
+
+    #
+    # Set the capital items
+    #
+    dol_per_kw = 500
+    kW = 50000/24*55.5
+    pf.add_capital_item(name='PEM Stack',cost=kW*dol_per_kw,depr_type='MACRS',depr_period=7,refurb=[0,0,0,0,0,0,0.15]*4) # Refurb 15% every 7 years
+    pf.add_capital_item(name='BOP',cost=1000000,depr_type='MACRS',depr_period=7,refurb=[0])
+
+    #
+    # Set the fixed costs
+    #
+    pf.add_fixed_cost(name='Fixed costs',usage=1,unit='$',cost=3000000,escalation=gen_inflation)
+
+    #
+    # Set the incentives
+    #
+    pf.add_incentive(name='45V',value=3,decay=0,sunset_years=10,tax_credit=True)
+
+    return pf
+
+
+
+if __name__ == '__main__':
+    pf = pf_setup()
+
+    # Price setter mode
+    NPV = pf.cash_flow()
+    print(f'IRR: {pf.irr}')
+    print(f'NPV: {NPV}')
+    print("\n")
+
+    # Price taker mode
+    sol = pf.solve_price()
+    price = sol['price']
+    irr = sol['irr']
+    ipp = sol['investor payback period']
+    lco = sol['lco']
+    print(f'First year price = {round(price,2)}')
+    print(f'Levelized cost = {round(lco,2)}')
+    print(f'IRR = {irr*100}%')
+    print(f'Investor payback period = {round(ipp,2)}')
+
+    # Plot cost breakdown
+    pf.plot_costs()
+
+    # Plot everything
+    pf.plot_time_series()
+
+
+
+    # What is the sensitivity to Electricity region?
+    regions = ['US Average','East North Central','East South Central','Middle Atlantic','Mountain','New England','Pacific','South Atlantic','West North Central','West South Central']
+    lcoh = []
+
+    for region in regions:
+        pf.edit_feedstock(name='Electricity (industrial)',value={'cost':region})
+        sol = pf.solve_price()
+        lcoh.append(sol['lco'])
+
+    plt.bar(regions, lcoh)
+    plt.xlabel("Regions")
+    plt.ylabel("Levelized cost of H2 ($/kg)")
+    plt.show()
+    pass