-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs, examples + Fix intermediate hook (#62)
- Loading branch information
Showing
13 changed files
with
769 additions
and
566 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Architecture | ||
|
||
The Simulation Service (soon to be renamed SciML Service) is a REST API that wraps | ||
specific SciML tasks. The service should match the spec [here](https://github.com/DARPA-ASKEM/simulation-api-spec) | ||
since PyCIEMSS Service and SciML Service ideally are hot swappable. | ||
|
||
The API creates a job using the JobSchedulers.jl library and updates the Terarium Data Service (TDS) with the status | ||
of the job throughout its execution. Once the job completes, the results are written to S3. With most of the output artifacts, we do little postprocessing | ||
after completing the SciML portion. | ||
|
||
## Layout | ||
|
||
Source is split into 5 major components: | ||
- `SimulationService.jl`: Contains the start and stop functions for the service | ||
- `Settings.jl`: Enumerates the environment variables used by the project | ||
- `service`: Job scheduling, pre/post-processing, endpoints, etc. Handled by TA4. | ||
- `contracts`: Location where TA3 and TA4 agree on an interface between the SciML Operations and the rest of the service. | ||
- `Available.jl`: The operations available to the API are here. Generally, the operations just wrap around by the exposed SciML | ||
operations. | ||
- `operations`: JuliaHub primarily focuses here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.