ajijohn / ebm

UI for Microclimatic data for ecological forecasting
microclim.org
Apache License 2.0
2 stars 0 forks source link

Suggested text change #19

Closed lbuckley closed 6 years ago

lbuckley commented 6 years ago

Add to main page: Below we detail the available microclimate data and access via a web interface and API.

Features page: Change “Dimensions filter” to “Data dimensions and options”?

Add below Variable specifications: The available variables correspond to those of the Weather Research & Forecasting (WRF) model and the additional microclimate model. Additional details are provided in Levy et al. (2016). All variables include a time dimension and some variables include additional dimensions of height or depth above the surface and shade level.

Footer: Change “If questions/concerns, please report it on our Github issues” to “Please add any questions, concerns, or suggestions as issues on the project’s Github page.”

USAGE page Registration Microclim.org does not have inbuilt authentication and authorization feature, but relies on Google for site registration. Google only provides us with access to your user name and email id. Once you use your Google credentials to log in, you are afforded access to the web interface where you can request a subset of miroclimate data. To the right of the web interface, you will find a link to a “My Account” page. There you can optionally update your profile. You can also access a secret and key code that can be used to request data via an API.

Data requests and limitations Data requests can be large due to the hourly time period and fine spatial resolution. Please keep file size in mind when selecting a geographic range. Using the web app, one can either enter coordinates to define a geographic bounding box or click on the rectangle icon to the left of the map. Dragging the rectangle icon around a region will update the coordinates of the bounding box.

We limit data requests to a maximum of 5 years in either the past or present. Please contact us if your application requires access to data for a longer time period. Each data request is for a single, continuous time period with data aggregated at the specified interval (from hourly to monthly).

Using the web App, click on a variable name to select it (a check mark confirms your selection) and click again to deselect a variable. You then have the option to select a single shade level and height or depth for each request. These selections will be disabled (and shaded) when they are not applicable to your data selection.

Multiple variable selection is permitted through API and Web App. Any selections of shade level or height/depth will be applied only to variables for which they are relevant [correct?].

Data are currently available in CSV or netCDF format. Please see the features page for a description of the output format as well as details on available data. Once requests are submitted in the Web App, the status bar at the bottom of the page will report the request status and can be updated using the request button.

API We offer API based on rest, which allows you to access our data in any language and from within any environment that support REST API framework. However, we support APIs in R and Python, and details can be found in our respective GitHub repositories: [LINKS]

We provide an example usecase below highlighting the use of our R API toolkit. The available APIs and their parameters are details on the APIs page. When requesting data via the fetch API, one combination of shade level and height/depth is available can be requested. [Explain whether the hod and shadelevel need to be indicated if they are NA.]

ajijohn commented 6 years ago

Updated the related sections