A tool for interacting with the SWx TREC Model Staging Platform VECTOR/SESAM model by Marcin Pilinski.
Deployed site: https://swx-trec.com/vector Dev site: https://dev.swx-trec.com/vector Branch demos: https://dev.swx-trec.com/`` Github pages site: https://swxtrec.github.io/vector
Title: VECTOR—Vehicle Environment Coupling and TrajectOry Response Description: Calculate the coefficient of drag, projected area, and force coefficient from a given set of input parameters Tagline: Drag coefficient calculated from a spacecraft's geometry and its surrounding environment
- Product Owner: Marcin Pilinski, [email protected]
- Experienced Devs: Frontend: Jennifer Knuth, [email protected] Backend: Greg Lucas, [email protected]
- SWT: Main project for the Space Weather Testbed codebase.
- Incorporate SESAM Model: Epic for VECTOR calculator
- Vector Updates: VECTOR epic
This is one of a suite of applications deployed to the SWx TREC Model Staging Platform at https://swx-trec.com.
GitHub organization: https://github.com/SWxTREC
Jenkins jobs are used to deploy the application and the application is built on internal libraries, so development needs to be done behind the firewall.
This is the frontend code that sets the parameters to run the VECTOR model in AWS.
A Flask backend has been set up to create an API that receives a POST request with the model parameters and returns a GET request with the result. The backend code is publicly available at https://github.com/SWxTREC/vector-code.
See 'Developement server' below.
VECTOR backend is needed.
Run npm start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
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.
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.
Run npm run build to build the project. The build artifacts will be stored in the dist/ directory. Run npm run build:prod for a production build.
Run npm run lint to lint your code, or run npm run lint:watch to automatically lint every time you change a file.
Automatically fix many linter warnings by running npm run lint:fix.
Run npm test to execute the unit tests via Karma.
Run npm run e2e to execute the end-to-end tests via Protractor.
If you are using docker, be sure to follow the instructions in after-fork.instructions.
Once you have followed the steps in after-fork.instructions you can run ./dockerctl.sh build to build a new image locally
Once you have built your image using the command above, you can ./dockerctl.sh run to start a local development image. This image will be served at http://localhost:8080/vector
To stop your image run ./dockerctl.sh stop
Cleaning up old images is also a good idea from time to time. To clean up your unused docker resources run docker system prune
When you are ready to push your image, contact the web team infrastructure group for credentials and instructions on how to log in. Once this is complete you can run ./dockerctl.sh publish to publish your image to the server.
Be sure to npm run lint && npm test before creating a PR.
When a PR is created, the branch is served, and can be reviewed, outside of the LASP network at https://dev.swx-trec.com/``. The branch deploy will update with changes to the branch code.
Merges to the dev branch will automatically be deployed to https://dev.swx-trec.com/vector. This is the dev deploy in the AWS environment and the contents of the dev branch will be reflected there. It uses a production build and the .dev environment file where production = false.
To manually trigger a deploy of the dev branch, run this job: https://jenkins-build.lasp.colorado.edu/job/swx-vector-dev/
Once https://dev.swx-trec.com/vector is tested and ready for a release, merge dev into main. From the main branch, run npm version <major | minor | patch> where major indicates a breaking change, minor is noticeable but non-breaking interface change, and patch is a non-breaking, under-the-hood refinement.
This will:
- run the linter and unit tests and abort if they fail
- increment the version, commit the change, and create a git tag
- push the changes and the new tag to the remote repo
- merge the version changes back into the dev branch
Run this Jenkins job https://jenkins-build.lasp.colorado.edu/job/swx-vector-prod/ to make a production build. Currently there is a manual step to deploy to the production AWS environment. Notify Brian McClellan or Greg Lucas to do this step. In future this will be automated.
From the master branch, run npm run deploy
This will:
- Run
npm run build:pagesto create the/docsdirectory that will be deployed - Make a copy of
docs/index.htmland name itdocs/404.html(for some reason the angular instructions say to do this) - Take the current build of
/docsfrom the current branch and push it up to the remotegh-pagesbranch were it will be served
After a few minutes, you will see the changes at the GitHub-hosted site https://swxtrec.github.io/vector.
You can run this script from any branch, but the site should reflect the content of the current master branch.