Challenge Overview
Project Overview
The goal of the NASA PDS (Planetary Data System) application is to load planetary observation data into a relational database (MySQL) in a format that will allow the data to be queried and inspected efficiently and quickly.
The focus for this project is Small Bodies Node (SBN) data, which specializes in data concerning asteroids, comets, and interplanetary dust.
The data is searchable on this website:
http://pds.nasa.gov/
Competition Task Overview
The goal of this challenge is to update the architecture documents with latest pds applications source code.
Detailed Requirements
We are looking for detailed documentation on the frontend and backend of pds applications as well as the integration between these applications.
The source code of this project are placed in private SVN repository , which is also deployed and verified (ready to use) on an Amazon EC2 VM, which will be available to you upon request.
We need documentation for the source code in these folders and how they interact with each other - in details :
- front_end : a demo frontend website for pds data
- import_and_persistence : core backend
- web_service : PDS SOAP web service
- web_service_example_client : web service example client
- web_service_javascript : web service javascript client
You are expected to deliver :
- Application Design Specification
- ERD Diagrams
- Sequence Diagrams - should also cover all interaction between pds applications as much as possible
- Interface and Class Diagrams
- Web Sevice Document - detailing endpoints with their request/response, and sample calls
- Any other information that would help understand how the source code works will be appreciated and evaluated by the reviewers and if useful will set the submission apart.
Please note that the documentation is expected to be used by a wide array of stakeholders, so high level documentation should be separated from thhe low level documentation and technical details.
VM, SVN
VM:
Before asking your own VM, you need to have a public key on your profile before asking for the VM.
How to generate a key: http://apps.topcoder.com/wiki/display/projects/Generate+SSH+Key
How to connect using it: http://apps.topcoder.com/wiki/display/projects/Connect+Using+SSH+Key
Note the following :
- The VM will have ubuntu OS installed on it.
- The source code is deployed under 'pds' user, the password is : pds
- Each application has a deployment guide along with it, it has been deployed and vierifed on the VM you will get, verification screens about successful deployment is provided under screens.zip file. Note that the VM is a clone of the original VM that we deployed the source code to, but you should not face any problem to re-run them. If you are facing any troubles, please post in challenge forums.
SVN:
The current assets exist here https://coder.topcoder.com/tcs/clients/ntl-pds/assets
If you don't have access, send request to support@topcoder.com.
Documentation Provided
Existing architecture document exist under architecture folder in svn.
Final Submission Guidelines
Submission Deliverables
- Application Design Specification
- ERD Diagrams
- Interaface Diagrams
- Sequence Diagrams
- Web Service Document
Submission Guidelines
For each member, the final submission should be uploaded to the Online Review Tool.