Commit b91f4168 authored by Devarakonda, Ranjeet's avatar Devarakonda, Ranjeet
Browse files

Update README.md

parent 4d368d72
# AGU/AMS-poster-api-wrapper
The AGU/AMS Poster API Wrapper is a standalone web application which enables the searching, storing,
# AGU/AMS Abstract Search and Display Software
The AGU/AMS Abstract Search and Display Software is a standalone web application which enables the searching, storing,
and displaying of abstracts featured at the annual American Geophysical Union (AGU) and American Meteorological Society (AMS) meetings.
This application is designed for those who wish to host a standalone web application and feature a select subset of
posters scheduled for the AGU/AMS meetings.
posters and talks scheduled for the AGU/AMS meetings.
Please read the entirety of this README.md file before attempting to download and use the application.
There are three views available via the UI:
......@@ -141,7 +141,7 @@ view by clicking the check box to the right of the search result. After making y
of the page and complete the reCAPTCHA challenge. Once the reCAPTCHA challenge is complete, click the submit button.
A popup should display indicating the submission was successful.
[](https://code.ornl.gov/arm-data-science-integration/poster-api-wrapper/uploads/0411d110ade38e00ee1e881ea920ef5e/Search_Example.png)
[See example search view](https://code.ornl.gov/arm-data-science-integration/poster-api-wrapper/uploads/0411d110ade38e00ee1e881ea920ef5e/Search_Example.png)
### Viewing posters on the summary view
To view posters selected for displaying on the summary view, click the `Summary` link in the navigation at the top of
......@@ -151,6 +151,8 @@ The poster and session titles are also hyperlinked, and clicking them will take
on the AGU/AMS site. Posters with multiple authors have the author column collapsed, and it can be expanded by clicking
the `More` text beneath the first author name.
[See example summary view](https://code.ornl.gov/arm-data-science-integration/poster-api-wrapper/uploads/7f57c55e0579198fb5509707632c1771/Summary_View_Example.png)
### Manual submissions
Sometime a poster may exist in the AGU/AMS API but may not show up as a search result when searching over the AGU/AMS API. In these
rare cases, it is possible to manually add posters via the manual submission view. To go to the manual submission view,
......@@ -162,7 +164,7 @@ Note this is for example only and at the time of this writing the URL in the pre
actual poster page.
# Citation
Darnell, W., Crow, M., Devarakonda, R., Prakash, G., Poster API Wrapper. Computer Software.
Darnell, W., Crow, M., Devarakonda, R., Prakash, G., "AGU/AMS Abstract Search and Display Software". Computer Software.
https://code.ornl.gov/arm-data-science-integration/poster-api-wrapper.
13 Jul. 2021. Web. doi:
......@@ -172,3 +174,6 @@ UT-Battelle
3-Clause BSD License
Copyright 2021, UT-Battelle, LLC
# Need help with usage or setup?
Contact: Ranjeet Devarakonda (devarakondar@ornl.gov)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment