Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sayanadhikari authored Mar 15, 2021
1 parent aad2ae9 commit 62a4882
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,46 @@
# DSMCPy (Direct Simulation Monte Carlo With Python)
A python code to simulate dilute gas with DSMC

Setup: Rayleigh Problem = gas between 2 plates ([Alexander & Garcia, 1997](https://doi.org/10.1063/1.168619))
A python code to simulate dilute gas with DSMC (Direct Simulation Monte Carlo)

Author: [Sayan Adhikari](https://github.com/sayanadhikari)[@sayanadhikari](https://twitter.com/sayanadhikari)
## Problem
Rayleigh Problem = gas between 2 plates ([Alexander & Garcia, 1997](https://doi.org/10.1063/1.168619))

Adapted from: [Philip Mocz](https://github.com/pmocz/dsmc-python), Princeton Univeristy, [@PMoc](https://twitter.com/PMocz)
## Contributors
- [Sayan Adhikari](https://github.com/sayanadhikari)[@sayanadhikari](https://twitter.com/sayanadhikari)
- [Rinku Mishra](https://github.com/rinku-mishra)

## Source
[Philip Mocz](https://github.com/pmocz/dsmc-python), Princeton Univeristy, [@PMoc](https://twitter.com/PMocz)
More details: http://www.algarcia.org/Pubs/DSMC97.pdf


Installation
------------
#### Prerequisites
1. make buildsystem
2. python3 or higher
3. git

#### Procedure
First make a clone of the master branch using the following command
```shell
git clone https://github.com/sayanadhikari/DSMCPy.git
```
Then enter inside the *DSMCPy* directory
```shell
cd picsp
```
Now complile and built the *DSMCPy* code
```shell
make all
```
Usage
-----
Upon successful compilation, run the code using following command
```shell
make run
```
Parameter Setup
----------------------
Edit the input.ini and run the code again.

0 comments on commit 62a4882

Please sign in to comment.