Update simulators.md

docs/simulators.md

@@ -4,9 +4,6 @@ By default, the backend will use the SHIELD-HIT12A demo version as particle tran
 This is a limited version of the full SHIELD-HIT12A code, can calculate only up to 10000 primary particles.
 Also it has no support for any type of parallelization (the random number generator is frozen at certain value).
 
-The backend uses full version of TOPAS simulator, as it is open source. This is also why encryption password
-and salt are not required for TOPAS. Geant4 files, required for TOPAS to run, will be downloaded along with it.
-
 ## Downloading simulators from S3 storage
 
 To deploy yaptide platform with other simulators one needs to provide a location of other simulators in the S3 storage infrastructure.
@@ -22,22 +19,13 @@ S3_SHIELDHIT_BUCKET=bucket_name_with_shieldhit12a_binary
 S3_SHIELDHIT_KEY=filename_of_shieldhit12a_binary
 S3_ENCRYPTION_PASSWORD=mysecret_password_to_decrypt_simulator_binary
 S3_ENCRYPTION_SALT=salt_to_decrypt_simulator_binary
-S3_TOPAS_BUCKET=bucket_name_with_topas_binary
-S3_TOPAS_KEY=filename_of_topas_binary
-S3_TOPAS_VERSION=version_of_topas
-S3_GEANT_BUCKET=bucket_name_with_geant4_files
 ```
 
 This contents of this file are following:
 
 * `S3_ENDPOINT`, `S3_ACCESS_KEY`, `S3_SECRET_KEY` - credentials to access S3 storage
 * `S3_SHIELDHIT_BUCKET`, `S3_SHIELDHIT_KEY` - location of SHIELD-HIT12A binary in S3 storage
 * `S3_ENCRYPTION_PASSWORD`, `S3_ENCRYPTION_SALT` - password and salt to decrypt SHIELD-HIT12A binary
-* `S3_TOPAS_BUCKET`, `S3_TOPAS_KEY` - location of TOPAS binary in S3 storage
-* `S3_TOPAS_VERSION` - version of TOPAS to be downloaded
-* `S3_GEANT_BUCKET` - location of Geant4 files in S3 storage (required for TOPAS)
-
-If any of the variables related to one of the simulators is not set, that simulator won't be downloaded.
 
 ## How to deploy backend with other simulators
 
@@ -103,3 +91,21 @@ and start them again:
 ```bash
 docker compose up --detach
 ```
+
+## TOPAS support
+In future we plan to add support for TOPAS simulator. Right now it could be installed in the worker container, but TOPAS simulations cannot be executed. To allow installation of TOPAS set following additional variables in the .env file.
+
+```
+S3_TOPAS_BUCKET=bucket_name_with_topas_binary
+S3_TOPAS_KEY=filename_of_topas_binary
+S3_TOPAS_VERSION=version_of_topas
+S3_GEANT_BUCKET=bucket_name_with_geant4_files
+```
+
+* `S3_TOPAS_BUCKET`, `S3_TOPAS_KEY` - location of TOPAS binary in S3 storage
+* `S3_TOPAS_VERSION` - version of TOPAS to be downloaded
+* `S3_GEANT_BUCKET` - location of Geant4 files in S3 storage (required for TOPAS)
+
+* `S3_TOPAS_BUCKET`, `S3_TOPAS_KEY` - location of TOPAS binary in S3 storage
+* `S3_TOPAS_VERSION` - version of TOPAS to be downloaded
+* `S3_GEANT_BUCKET` - location of Geant4 files in S3 storage (required for TOPAS)