LCA-PrOMMiS Integrated Application

The Jupyter Notebook, PrOMMiS_LCA_Model.ipynb, presents a workflow that falls at the intersection of life cycle assessment (LCA) and the process optimization and modeling for minerals sustainability (PrOMMiS). This application (in its current version) allows users to evaluate critical mineral processing flowsheets via PrOMMiS, and use the corresponding results to evaluate the environmental impact of the flowsheet using life cycle assessment. PrOMMiS is an open-source code, that enables design choices with costing, to perform process optimization, and to accelerate development and deployment of extraction and purification processes for critical minerals/rare earth elements at reduced risk (.html).

Disclaimer

The National Energy Technology Laboratory (NETL) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use.

Repository Organization

lca-prommis/
├── images/
│   ├── system_boundary_1.png
│   └── uky_flowsheet.png
│
├── output/
│   ├── lca_df.csv                     <- PrOMMiS raw data CSV
│   ├── lca_df_converted.csv           <- Unit-converted and aggregated data
│   └── lca_df_finalized.csv           <- Normalized to functional unit
│
├── resources                          <- directory for openLCA database
│                                         downloaded from EDX
│
├── src/
│   ├── create_olca_process        <-  Submodule for creating unit processes
│   │   ├── __init__.py
│   │   ├── create_exchange_elementary_flow.py  <- function to create an exchange for an elementary flow
│   │   ├── create_exchange_pr_wa_flow.py       <- function to create an exchange for product and waste flows
│   │   ├── create_exchange_database.py         <- function to create an exchange database
│   │   ├── create_exchange_ref_flow.py         <- function to create an exchange for the quantitative reference
│   │   │                                              flow
│   │   ├── create_new_process.py               <- main function to create new process in openLCA
│   │   ├── find_processes_by_flow.py           <- function to query an openLCA database and find the
│   │   │                                              provider for specific flows
|   │   ├── flow_search_function.py             <- function to query an openLCA database and find a flow by
│   │   │                                              keyword
│   │   ├── search_flows_and_providers.py       <- user interface code to search for flows and their associated
│   │   │                                              providers
│   │   └── search_flows_only.py                <- user interface code to search and extract only flows
│   │
│   ├── __init__.py
│   ├── prommis_LCA_data.py                     <- code to run PrOMMiS model and extract data
│   ├── prommis_LCA_conversions.py              <- code to convert PrOMMiS data to LCA relevant units
│   ├── finalize_LCA_flows.py                   <- code to normalize data to FU and assign UUIDs to
│   │                                                 elementary flows
│   ├── create_ps.py                            <- function to create product system given a unit process
│   ├── run_analysis.py                         <- function to assign impact assessment method and run
│   │                                                 analysis
│   ├── import_db.py                            <- function to import openLCA database from EDX
│   ├── generate_total_results.py               <- function to generate total LCA results
│   └── generate_contribution_tree.py           <- function to generate results by category
│                                                    (contribution tree)
│
├── .gitignore                                  <- Git repo ignore list
├── Notes.txt                                   <- Notes summarizing approach to develop the PrOMMiS LCA model
├── README.md                                   <- The top-level README.
├── requirements.txt
└── PrOMMiS_LCA_Model.ipynb                     <- Jupyter notebook with steps to develop LCA model

Setup

The instructions for setup are based on those found here.

1. Create new virtual environment

   conda create -n prommis python=3.12 -y

2. Activate

   activate prommis

3. Install prommis

   pip install prommis

4. (Optional) Check the version of IDAES

   idaes --version

5. Install the extensions

   idaes get-extensions --extra petsc

6. Test the installation (and be prepared to wait)

   pytest --pyargs idaes -W ignore

   If this step fails, pip-install pyargs in the virtual environment and try again.

7. Download or clone the repository

   To download, go to the "Code" page of the repository, click the green "Code" button and click "Download ZIP".

   To clone:

   git clone https://github.com/KeyLogicLCA/lca-prommis.git

8. Install JupyterLab (Recommended)

   pip install jupyterlab

Install and Run

1. Ensure you're in the correct directory

   cd lca-prommis

2. Launch Jupyter Notebook

   jupyter lab

3. Open PrOMMiS_LCA_Model.ipynb and run the cells in order, following the provided instructions as you go.