Skip to content

Commit 4cc9a48

Browse files
Update README.md
1 parent bb598b5 commit 4cc9a48

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,12 @@ It is required that the new files given by the user should follow the same forma
2121
## Running the program
2222
The user can run the program either on jupyter, google colaboratory, or terminal using the commands.
2323
### To run the program using jypyter notebook or google colaboratory
24-
the file <code>GHRSS_survey_plot.ipynb</code> must be opened. It is required to run each cell in the sequential order before running the last cell containing the following code:
25-
```
26-
ghrss_obj = GHRSS()
27-
ghrss_obj.accept_choice()
28-
```
29-
Here GHRSS is the class defined in the second cell, and ghrss_obj is the object of class GHRSS. function <code>accept_choice()</code> is defined in this class and accepts the input from user. In order to plot more, this cell can be rerun.
30-
If the user is running the program on google colaboratory, then all the data files can be saved on google drive, and the path of these files must be given wherever required.
24+
It is required to run the single cell in <code>GHRSS_survey_plot.ipynb</code>
25+
26+
If the user is running the program on google colaboratory, then all the data files can be saved on google drive, and the path of these files must be given <code>config.py</code>
3127

3228
### To run the program using command on terminal
33-
it is required to run only <code>main.py</code> file using the following command.
29+
It is required to run <code>main.py</code> file using the following command.
3430
```
3531
python3 main.py
3632
```
@@ -57,3 +53,22 @@ While plotting onto the existing graph, if the user is plotting sources, the plo
5753
## Output
5854
The output of the program is a single figure containing the plots for all data files as given by the user. The figure contains a legend denoting the color and symbol used for a particular data. The labels used in the legend are the same as the file names. The normal pulsars, MSPs, and RRATs are all given different symbols. It is required that in order to change the markers/colors, necessary changes in the file (<code>config.py</code>) can be made. The following figure shows a sample output plot of the program.
5955
![GHRSS_plot1](https://user-images.githubusercontent.com/101509174/164984008-261fcb9c-6680-409c-ba06-17eeec25eb90.png)
56+
57+
# Survey area plots
58+
This code is the python program to plot the survey areas on the galatic coordinate system using the declination range or the latitude and longitude range. The output of the program is the single plot containing the shaded area with the sky temeperature map (Haslam 408 MHz Map)
59+
60+
## Running the program
61+
The package <code>survey_area</code> contains the functions for plotting survey areas. It is required to run <code>main_survey_plots.py</code> file using the following command.
62+
```
63+
python3 main_survey_plots.py
64+
```
65+
66+
Ensure that the Python environment has required python packages.
67+
68+
## Input
69+
The user is given the choice of shading the survey area using 2 options
70+
* declination range: maximum and minimum value of declination should be entered.
71+
* Lattitude and longitude range: maximum and minimum value of the latitude and longitude should be entered.
72+
73+
## Output
74+
The plot shows the shaded survey region according to the entered values with the sky temperature map.

0 commit comments

Comments
 (0)