Skip to content

Commit 9674b2d

Browse files
authored
Merge pull request #28 from warrickball/patch-1
Thanks for the fix! I'll add an issue to review the docs for typos
2 parents 15b3500 + 2fd85db commit 9674b2d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ variable in the ``atlasapiclient/utils.py file``.
3535

3636
For example:
3737
```python
38-
from atlasapiclient import client as atlaspaiclient
38+
from atlasapiclient import client as atlasapiclient
3939

40-
client = atlaspaiclient.APIClient()
40+
client = atlasapiclient.APIClient()
4141
client.refresh_token()
4242
```
4343

@@ -84,9 +84,9 @@ cp api_config_template.yaml api_config_MINE.yaml
8484
### Cone Search
8585

8686
``` python
87-
from atlasapiclient import client as atlaspaiclient
87+
from atlasapiclient import client as atlasapiclient
8888

89-
client = atlaspaiclient.ConeSearch(payload={'ra': 150,
89+
client = atlasapiclient.ConeSearch(payload={'ra': 150,
9090
'dec': 60,
9191
'radius': 60,
9292
'requestType': 'nearest'},
@@ -99,10 +99,10 @@ client = atlaspaiclient.ConeSearch(payload={'ra': 150,
9999
To get the data:
100100

101101
```python
102-
from atlasapiclient import client as atlaspaiclient
102+
from atlasapiclient import client as atlasapiclient
103103

104104
atlas_id = '1161600211221604900'
105-
client = atlaspaiclient.RequestSingleSourceData(atlas_id=atlas_id, get_response=True)
105+
client = atlasapiclient.RequestSingleSourceData(atlas_id=atlas_id, get_response=True)
106106
```
107107

108108
To extract the light curve data from the JSON:
@@ -151,9 +151,9 @@ ax.legend()
151151
### Data for Multiple Objects
152152

153153
```python
154-
from atlasapiclient import client as atlaspaiclient
154+
from atlasapiclient import client as atlasapiclient
155155

156-
client = RequestMultipleSourceData(atlas_ids=YOUR_LIST_OF_IDS, mjdthreshold = LOWER_MJD_THRESHOLD)
156+
client = atlasapiclient.RequestMultipleSourceData(array_ids=YOUR_LIST_OF_IDS, mjdthreshold = LOWER_MJD_THRESHOLD)
157157
client.chunk_get_response() # Chunks the list of IDs into a bunch of payloads and colates the responses.
158158
```
159159

0 commit comments

Comments
 (0)