Angular-3D-MMS

This project was generated with Angular CLI version 7.3.8.

Contacts

• Product Owner: Fernando Sanchez
• Experienced Devs:
  • Fernando Sanchez
  • Devin Noth
  • Jenny Knuth

Angular-3D-MMS Summary

Angular-3D-MMS is an implementation of the base LASP 3D application for the MMS mission. It displays a 3D rendering of Earth with the MMS Spacecrafts orbiting it. Users can choose from different datasets to plot as well as load visualizations of the data in the viewer itself. This data is usually collected by MMS itself, but also can be generated by scientific models and other sources.

Local Development

Run npm install to install package dependencies (requires node/npm to be installed globally on your machine).

Run npm start for a local server. Navigate to http://localhost:4200/.

There are two environment files:

• src/environments/environment.ts: used for running a local server
• src/environment/environment.prod.ts: used for running a production server

IMPORTANT: The developer is responsible for obtaining two of the four pieces of the environment file on their own. These are a Cesium Ion Token, and a Bing Maps API Key. Instructions for obtaining each can be found below.

Obtaining a Cesium Ion Token

1. Navigate to https://cesium.com/ion/ and sign up for a free account.

2. Click on the Access Tokens tab on the Cesium Ion homepage, then select Create Token.

3. Select a name for your new token and choose the scopes or restrictions to place on that token. Note, these are not too significant to running the application. For reference, we used the assets:read and geocode scopes for the development token.

4. After creating your token, click on your new token and copy and paste the value under Token into the CESIUM_KEY string in your environment files. You do NOT need multiple tokens for each environment file.

Obtaining a Bing Maps API Key

1. Navigate to Microsoft's Bing Maps Key Guide and follow the instructions to receive a key.

2. Insert the key into the BING_KEY string in your environment files. You do NOT need multiple keys for each environment file.

The LATIS_BASE constant in environments/environment.ts will determine which latis catalog you will hit with the local development branch to get all the needed metadata.

LaTiS

Angular-3D-MMS uses a LaTiS API endpoint to serve data. Additional documentation for this specific LaTiS instance can be found at https://lasp.colorado.edu/mms/sdc/public/3dlatis/latis/.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.