Skip to content

Commit bd8cfae

Browse files
Update README.md
1 parent 55bc8f2 commit bd8cfae

1 file changed

Lines changed: 17 additions & 3 deletions

File tree

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,30 @@ Now you should have the MAGNETO code successfully installed on your computer. No
1515
## Usage
1616
*Dependencies*: Python 3, NumPy and Matplotlib.
1717
There are two ways to run MAGNETO: By following the default method or the custom method. The custom method gives more freedom over physical parameters.
18-
### Default
18+
19+
### Default Configuration
1920
1. Open MAGNETO-Code directory in your terminal.
2021
2. Run the following command:
2122
```bash
2223
> bash run.sh
2324
```
2425
This will run the simulation with some default values of the magnetar's magntic field energy and power-law index.
2526

26-
## User Guide
27-
It is highly recommended to go through the user guide to learn to use MAGNETO: https://github.com/Kushaalkumar-pothula/MAGNETO-Code/wiki
27+
### Custom Configuration
28+
In this method of running MAGNETO, you will have control over the physical aspects of the magnetar. You can specify the values of the respective parameters using options while running scripts. To get help with them, you can run:
29+
```bash
30+
> python energy_evol_modular.py -h
31+
usage: energy_evol_modular.py [-h] E [E ...] a [a ...]
32+
33+
Simulate flaring activity of a magnetar using the Monte Carlo method.
2834

35+
positional arguments:
36+
E Total magetic energy of the magnetar
37+
a Power of time in energy-time relation, known as alpha
38+
39+
optional arguments:
40+
-h, --help show this help message and exit
41+
```
42+
2943
## Author
3044
Kushaal Kumar Pothula (www.sites.google.com/view/kushaal-kumar-pothula)

0 commit comments

Comments
 (0)