Skip to content

Latest commit

 

History

History
104 lines (65 loc) · 4.27 KB

README.md

File metadata and controls

104 lines (65 loc) · 4.27 KB
Raw

Moment Gauge: A Python Library for Maximal Entropy Moment Method Based on JAX

Moment Gauge is a Python library designed to facilitate the implementation of numerical solvers using the maximal entropy moment method. Built on the JAX framework, Moment Gauge aims to provide reusable code for researchers and developers working with rarefied gas dynamics and other applications of the maximal entropy moment method. It is also the code implementation of the paper "Stabilizing the Maximal Entropy Moment Method for Rarefied Gas Dynamics at Single-Precision".

The library offers a range of features, including sampling, optimization, and moment-computing methods for the exponential family distribution. This distribution family is known for having maximized entropy given a set of moments, and is the foundation of maximal moment method in the study of rarefied gas dynamics and other related fields.

Please note that Moment Gauge is not fully optimized for speed. However, its flexibility make it a good choice for those looking to quickly implement and test numerical solvers using the maximal entropy moment method.

Follow the installation guide to get started with Moment Gauge, and refer to the documentation for detailed information on using the library and its features. Detailed explaination of the maximal entropy moment method are described in our paper.

Prerequisites

Installation

Follow these steps to install Moment Gauge and its dependencies:

1. Clone the repository

First, clone the Moment Gauge repository from GitHub using the following command:

git clone https://github.com/scraed/TheMomentGauge.git

This will create a new directory called TheMomentGauge containing the project files.

2. Create a Conda environment

To install the required dependencies, create a new Conda environment using the provided environment.yml file. First, navigate to the TheMomentGauge directory:

cd TheMomentGauge

Next, create the Conda environment:

conda env create -f environment.yml

This command will create a new Conda environment with the necessary dependencies.

3. Activate the Conda environment

Activate the Conda environment by running:

conda activate moment_gauge

4. Install JAX

JAX is a required dependency for Moment Gauge. Follow the instructions below to install JAX with or without GPU support. You could use the latest version of JAX, but we have only tested the code on JAX 0.4.1. Please report to us if the code does not campatible with the latest version of JAX.

CPU Installation

To install a CPU-only version of JAX, run the following commands:

pip install --upgrade pip
pip install --upgrade "jax[cpu]"

GPU Installation

Please refer to the official JAX installation guide for more instructions on installing JAX with GPU support.

5. Add the package to PYTHONPATH

In order to use the Moment Gauge library in your Python projects, you need to add the package to your PYTHONPATH. For example, if the directory is located at /home/user/TheMomentGauge, the command would be:

export PYTHONPATH=$PYTHONPATH:/home/user/TheMomentGauge

To make this change permanent, add the above command to your shell's configuration file (e.g., .bashrc or .zshrc).

Usage

With Moment Gauge installed, you can now run the demo project computing a normal shock wave at Mach 1.2 using second-order Lax-Wendroff scheme method as follows:

cd demos
python NormalShock_LaxWendroff_Ma1.2.py

For more information on using Moment Gauge, refer to the project documentation and examples provided in the repository.

Citation

If you use Moment Gauge in your research, please cite our paper:

@misc{zheng2023stabilizing,
      title={Stabilizing the Maximal Entropy Moment Method for Rarefied Gas Dynamics at Single-Precision},
      author={Candi Zheng and Wang Yang and Shiyi Chen},
      year={2023},
      eprint={2303.02898},
      archivePrefix={arXiv},
      primaryClass={physics.flu-dyn}
}