::Python-based Hydrate-Liquid-Vapor phase equilibrium extractor::
Gas hydrate is a valuable resource due to its numerous advantages, and it is being used in various industries and applications. For example, its stability under pressure makes it an important component in natural gas processing and transportation systems, such as pipelines and subsea production. Moreover, it is being studied for other uses such as energy storage, carbon capture, and sequestration.
In order to fully exploit and manage gas hydrate resources, it is necessary to understand the phase equilibrium, or Hydrate (H) - Liquid (L) - Vapor (V) equilibrium (EQ). After forming a gas hydrate inside the pressure cell (decreased pressure), the researcher must slowly dissociate the hydrate by increasing the temperature and pressure. By observing the hysteresis loop in the pressure-temperature (P-T) diagram, the desired equilibrium point can be achieved. Once the equilibrium point is achieved, the hydrate properties can be studied further.
Note that obtaining an equilibrium point requires the user to spend time finding the EQ point every time the experiment has finished. The procedure is time-consuming, and manual data tracking can be quite annoying for researchers. Therefore, I developed PyHLV to save time in finding points and plotting their curves. PyHLV is an open-source EQ point-finding package written in Python and designed to automate the process of obtaining the equilibrium point and plotting curves for the user. It accelerates the process of obtaining the equilibrium point through a series of automated calculations and plotting. Furthermore, it eliminates the need for manual data tracking, thus saving time and reducing the effort needed to complete experiments.
Furthermore, PyHLV has been tested extensively on various datasets and has proven to be a reliable and user-friendly tool for researchers. It is highly customizable and allows the user to configure the settings according to their specific needs. With PyHLV, researchers can quickly and easily obtain and plot the equilibrium point, thus significantly reducing the time spent on the experiment.
PyHLV is a simple phase EQ extractor for gas hydrate researchers. It is a Python-based program that can extract the phase EQ point from the P-T data of the hydrate system. The program is designed to be simple and user-friendly, so that even a person who has no programming experience can use this.
PyHLV offers the following features:
- Data extraction: Extract phase EQ point from the P-T data of the hydrate system.
- Data visualization: Visualize the phase EQ point with the original graph.
- Data storage: Store the data in the form of CSV files and zip folders.
PyHLV works in the following steps:
- Read the P-T data from the user-specified file.
- Flatten the P-T data for accurate extraction of the phase EQ point.
- Find the rupture point of the P-T data.
- Estimate the phase EQ point by finding the line connecting the first and last points.
- Mark the tipping point with the original graph.
- Combine the 'Phase EQ Overview' and 'Obtained Phase EQ' graphs into the one graph.
- Store and compress the data.
- Export the completion message to the user.
PyHLV is designed to be simple and user-friendly. However, it has the following limitations:
- Only works for extracting phase equilibrium points from P-T data of the DWStemp program (Dongwon logging software; refer to the raw data stored in the
examples/folder). If the data is from another software, the user needs to manually convert the data into a compatible format. The software will then be able to produce the equilibrium points and display them graphically. - User must adjust option values (ninput, stepreg, pen, etc.), if P-T data is too complicated.
- Can only process one file at a time.
Typing the following command in the terminal will install the program.
$ pip install pyhlv
To use the program, type the following command in the terminal.
$ pyhlv
PyHLV allows users to customize their usage through command-line arguments. The available options are:
| Argument | Description | Explanations |
|---|---|---|
| -p | Pressure sensor number (1 or 2), (default=1) | Pressure sensor port number you used |
| -t | Temperature sensor number (1, 2, 3, or 4), (default=1) | Temperature sensor port number you used |
| -n | How many inputs do you want to use? (default=2) | What number of rupture points to choose? |
| -s | How many steps do you want to analyze? (default=1000) | How many points around the found rupture point to observe? |
| -P | Penalty value for Pelt algorithm (default=1200) | Choose ruptures penalty value (high for sensitive, low for insensitive) |
| -d | Directory location of the csv files (default=./) | Folder path with raw csv file(s) |
| -v | Display the version of your installed PyHLV | Show version information to you |
To use the command-line arguments, type the following command in the terminal:
$ pyhlv [option] [value]
Note that the values should be specified in the same order as the arguments. For example, to use the -d argument, the command should be as follows:
$ pyhlv -d [directorylocation]
For more information, type pyhlv -h or pyhlv --help in the terminal.
PyHLV requires the following packages to be installed:
pandasnumpymatplotlibseabornrupturestabulatepyfigletargparse
.png)
This program is licensed under the MIT License. For more information, please refer to the LICENSE file.
This program was developed by wjgoarxiv
In the future, PyHLV will be improved to include additional features such as:
- Ability to process multiple files at once.
- Support for complex P-T data.
- Ability to detect multi-phase regions in the P-T data.
Of course, you can run PyHLV in the following Google Colab notebooks. There are two different versions; one is a segmented version, which allows users to run each step individually, and the other is compiled version, which allows users to simply run the code.