docs: update html and readme

AllenNeuralDynamics · Apr 29, 2024 · 7c52587 · 7c52587
1 parent a262b5c
commit 7c52587
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,9 @@ You can go to http://aind-data-transfer-service to submit a `.csv` or `.xlsx` fi
 
 What each column means in the job submission template:
 
+- **processor_full_name**: Name of the person submitting the upload job
+- **project_name**: Project name. A full list can be downloaded at [Project Names](http://aind-metadata-service/project_names)
+- **process_capsule_id**: Optional Code Ocean capsule or pipeline to run when data is uploaded
 - **platform**: For a list of platforms click [here](https://github.com/AllenNeuralDynamics/aind-data-schema/blob/main/src/aind_data_schema/models/platforms.py).
 - **acq_datetime**: The time that the data was acquired
 - **subject_id**: The unique id of the subject
@@ -70,8 +73,12 @@ platform = Platform.BEHAVIOR
 behavior_config = ModalityConfigs(modality=Modality.BEHAVIOR, source=(source_dir / "Behavior"))
 behavior_videos_config = ModalityConfigs(modality=Modality.BEHAVIOR_VIDEOS, source=(source_dir / "Behavior videos"))
 metadata_dir = source_dir / "Config"  # This is an optional folder of pre-compiled metadata json files
+processor_full_name="Anna Apple"
+project_name="Ephys Platform"
 
 upload_job_configs = BasicUploadJobConfigs(
+  processor_full_name=processor_full_name,
+  project_name=project_name,
   s3_bucket = s3_bucket,
   platform = platform,
   subject_id = subject_id,

diff --git a/src/aind_data_transfer_service/server.py b/src/aind_data_transfer_service/server.py
@@ -48,7 +48,6 @@
 # BASIC_JOB_SCRIPT
 # OPEN_DATA_AWS_SECRET_ACCESS_KEY
 # OPEN_DATA_AWS_ACCESS_KEY_ID
-# AIND_PROJECT_NAMES_URL
 
 
 async def validate_csv(request: Request):

diff --git a/src/aind_data_transfer_service/templates/index.html b/src/aind_data_transfer_service/templates/index.html
@@ -47,6 +47,7 @@
         <a href="/">Submit Jobs</a> |
         <a href="/jobs">Job Status</a> |
         <a title="Download job template as .xslx" href= "/api/job_upload_template" download>Job Submit Template</a> |
+        <a title="List of project names" href= "http://aind-metadata-service/project_names" >Project Names</a> |
         <a title="For more information click here" href="https://github.com/AllenNeuralDynamics/aind-data-transfer-service/tree/main?tab=readme-ov-file#aind-data-transfer-service"  target="_blank" >Help</a>
     </nav>
     <br>

diff --git a/src/aind_data_transfer_service/templates/job_status.html b/src/aind_data_transfer_service/templates/job_status.html
@@ -26,7 +26,9 @@
     <nav>
         <a href="/">Submit Jobs</a> |
         <a href="/jobs">Job Status</a> |
-        <a title="Download job template as .xslx" href= "/api/job_upload_template" download>Job Submit Template</a>
+        <a title="Download job template as .xslx" href= "/api/job_upload_template" download>Job Submit Template</a> |
+        <a title="List of project names" href= "http://aind-metadata-service/project_names" >Project Names</a> |
+        <a title="For more information click here" href="https://github.com/AllenNeuralDynamics/aind-data-transfer-service/tree/main?tab=readme-ov-file#aind-data-transfer-service"  target="_blank" >Help</a>
     </nav>
     <h2>Jobs Submitted: {{num_of_jobs}}</h2>
     <table>