This is for the SAMs website that was developed for NASA's OCO-3 mission.
The OCO-3 Snapshot Area Mapping(SAM) was built using a LAMP configuration. The site employs very basic styling from Bootstrap 5, so you are left to style the site the way you would like.
Authentication to the database, port numbers, and server names are stored in a 'config.json' file that in the 'private' directory. You should move this directory one level above the webroot. Make sure to update that path in any pages that need to access it.
Several directories store reports, images, and other files. Some may need to be added as empty directories manually as they are not included in the repo.
| Directory | Purpose |
|---|---|
| authentication/ | Code for the login area of the site |
| db/ | Contains a database file with the expected structure of the backend database |
| favorites/ | Area of the sites where users can selet their 'favorite' sites and get email alerts about them. |
| includes/ | Shared files used througout the site |
| includes/files/ | Shared header and footer files |
| includes/js/ | Shared Javascript functions |
| plots/ | Top directory for all the different types of plots |
| plots/co/ | CO plots |
| plots/dp/ | DP plots |
| plots/no2/ | NO2 plots |
| plots/none/ | Geostationary plots |
| plots/o2_radiance/ | O2 Radiance plots |
| plots/sif_757nm/ | SIF 757nm plots |
| plots/xco2/ | XCO2 plots |
| plots/xco2_bc_qf/ | XCO2 bias corrected and quality filtered plots |
| plots/xco2_bc_qf_goes/ | XCO2 bias corrected and quality filtered geostatoinary plots |
| private/ | Any credentials for the site; should move this out of webroot folder for production |
| requests/ | Users can submit requests for SAMs in this area |
| requests/disposition/ | Team members can approve or reject SAM requests in this area |
| utils/ | Utility script for the site |
The website is powered by a LAMP configuration. Any credentials should be in the private/config.json file. Remember to move the private folder out of your webroot directory for production.
The front end of the site icludes the following pages:
- Homepage: Page with introductory information about the site. It also inludes a map showing all target sites that have collected data. Users can search for specific SAMs on a form, and the results of this search will show up in a DataTables area for the user to scroll through. In the results, users can click on a SAM to display all available plots for that SAM.
- Favorites: This area allows users to create a list of 'favorite' sites from all available target sites. They will receive email alerts whenever new SAMs for their favorite sites become available. They can also use the search form to search for SAMs within their favorite sites. The results of this search are shown in a DataTable where they can view all plots for a SAM in their results, and request subsetted XCO2 data for that SAM.
- Request a SAM: Users can use this form to request an observation (a SAM or Target observation) by drawing the area of interest on the map, selecting a time range, and entering a science justification. This request will then be approved or rejected by the team.
- Login: This page allows the user to login to the site so they can submit requests or create a list of favorite sites.
There are places throught this repository that contain placholder URLs and email addresses. You will need to go through the site and update those as needed.
This website is backed by a local MySQL database. The structure of the database can be found in db/sams_db_structure.sql.
Users are responsible for implementing any site security mechanisms. Recommend ones include, but are not limited to, reCAPTCHA and CSRF tokens. Please also review cleaning user inputs on forms and consider if you should clean inputs further.
The scripts located in the utils directory are meant to be run in a crontab to sent emails out when news SAMs for sites are added to the database or when a subsetting job is complete. These are Python scripts.