{"id":28271034,"url":"https://github.com/cytomining/profiling-template","last_synced_at":"2026-01-20T16:33:15.069Z","repository":{"id":40349486,"uuid":"280182838","full_name":"cytomining/profiling-template","owner":"cytomining","description":"Image-based Profiling Template","archived":false,"fork":false,"pushed_at":"2025-06-27T17:59:12.000Z","size":42,"stargazers_count":0,"open_issues_count":10,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-04T23:38:31.890Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cytomining.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-07-16T14:58:53.000Z","updated_at":"2025-01-21T17:31:16.000Z","dependencies_parsed_at":"2025-01-03T19:20:58.074Z","dependency_job_id":"38412846-0429-4236-9fb7-79a64ae6a8ac","html_url":"https://github.com/cytomining/profiling-template","commit_stats":null,"previous_names":[],"tags_count":2,"template":true,"template_full_name":null,"purl":"pkg:github/cytomining/profiling-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytomining%2Fprofiling-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytomining%2Fprofiling-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytomining%2Fprofiling-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytomining%2Fprofiling-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cytomining","download_url":"https://codeload.github.com/cytomining/profiling-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cytomining%2Fprofiling-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28607283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-20T17:24:33.882Z","updated_at":"2026-01-20T16:33:15.057Z","avatar_url":"https://github.com/cytomining.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Image-based Profiling Template\n\nThis repository was derived from a [template repository](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/) located at https://github.com/cytomining/profiling-template.\nThe purpose of the repository is to weld together a versioned data processing pipeline with versioned processed output data for a single image-based profiling experiment.\n\n(Derived from this [template](https://github.com/broadinstitute/pooled-cell-painting-profiling-template))\n\n**DO THE FOLLOWING AFTER GENERATING A NEW REPO:**\n\n- Change the title following the format: \"Image-based Profiling for [ProjectName]\"\n- Fill in all sections below the marker with your project's information\n- Either fill out the metadata template or link to your external tracking system\n- Note that all discussions related to this dataset should happen in the corresponding GitHub issues\n- Delete the instructions (from the top of this document to the marker line below so that the README starts with \"Image-based Profiling for [ProjectName]\"\n\n## Setup\n\nTo correctly initialize the repository, we need to perform several manual steps.\n\n### Step 0: Create a new repository **using this repository as a template**\n\nBy spinning up a new repo using this repo as a template, you will retain all code, configuration files, computational environments, and directory structure that a standard image-based profiling workflow expects and produces.\n\n### Step 1: Fork the `profiling-recipe` repo\n\nWe first want to [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the official profiling recipe located at https://github.com/cytomining/profiling-recipe.\n\n* **Result:** The fork creates a copy of a recipe repository.\n* **Goals:** 1) Remove the connection to official recipe updates to avoid unintended weld versioning reversal; 2) Enable independent updates to fork code that does not impact official recipe.\n* **Execution:** See [forking instructions](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).\n\n\n### Step 2: Create a submodule inside this repository of the forked recipe\n\nNext, we will create a [submodule](https://gist.github.com/gitaarik/8735255) in this repo.\n\n* **Result:** Adding a submodule initiates the weld.\n* **Goals:** 1) Link the processing code (recipe) with the data (current repo); 2) Require a manual step to update the recipe to enable asynchronous development.\n* **Execution:** See below\n\n```bash\n# In your terminal, clone the repository you just created (THIS REPO)\nUSER=\"INSERT-USERNAME-HERE\"\nREPO=\"INSERT-NAME-HERE\"\ngit clone git@github.com:$USER/$REPO.git\n\n# Navigate to this directory\ncd $REPO\n\n# Add the recipe submodule\ngit submodule add https://github.com/$USER/profiling-recipe.git profiling-recipe\n```\n\nRefer to [\"Adding a submodule\"](https://gist.github.com/gitaarik/8735255#adding-a-submodule) for more details.\n\n### Step 3: Commit the submodule\n\nLastly, we will [commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project#about-commits) the submodule to github.\n\n* **Result:** Committing this change finalizes the weld.\n* **Goals:** 1) Track the submodule (recipe) version with the current repository.\n* **Execution:** See below\n\n```bash\n# Add, commit, and push the submodule contents\ngit add profiling-recipe\ngit add .gitmodules\ngit commit -m 'finalizing the recipe weld'\ngit push\n```\n\n----\n\n**DELETE EVERYTHING ABOVE THIS LINE AND START WITH THE CONTENT BELOW**\n\n# [Project Name]\n\n## Overview\n\n[Brief description of the experiment/dataset (2-3 sentences)]\n\n## Project Information\n\n- **Start Date**: YYYY_MM_DD (of the first batch)\n- **Related data repos**: [Links to related data repositories]\n- **Metadata Location**: [Link to external metadata tracking system, if applicable]\n- **Analysis Repo**: [Link to associated analysis repositories]\n\nNote: All discussions related to this dataset should happen in the GitHub issues of this repository. \n\n## Processing Details\n\n- **Pipeline Modifications**: [Any changes from standard pipeline]\n- **Other notes**:\n  - [Any other notes related to processing]\n\n## Experimental Metadata\n\nBelow is the template for tracking experimental metadata. Fill this out if not using an external tracking system.\n\n\u003cdetails\u003e\n\u003csummary\u003eMetadata Template\u003c/summary\u003e\n\n```\nCell type : _______ (ex: U2OS)\nCell source: ________ (ex: Collab lab) (ex: GPP)\nPlate size : _______ (ex: 384)\nPlate brand : _______ (ex: Cell carrier Ultra)\nCell densit(y/ies) : _______ (ex: 2K/well) (ex: Columns A-D 1K/well, Columns G-H 500/well)\nType of perturbation : ___________ (ex: Gene overexpression) (ex: CRISPR KO + compounds)\nIf (at least partially) genetic:\n    Genetic introduction method : __________ (ex : lentiviral transduction)\n    Selection method : _________ (ex: None) (ex: Puromycin 1ug/mL 24 hrs)\n    Number of genes : __________ (ex: 384)\n    Number of perturbations per gene : __________ (ex: N/A) (ex: 4 guides per gene)\nIf (at least partially) chemical :\n    Number of chemicals : __________ (ex: 384)\n    Number of dose points per chemical : _________ (ex: 1)\nNumber of replicates per perturbation : __________ (ex: 5)\nPerturbation time point : _____________ (ex: 72 hrs)\nStaining protocol : ____________ (ex: CellPainting v3 (LINK)) (ex: LipocytePainting (CITATION)) (ex: 1:500 gt anti tubulin (cat #), 1:1000 A488 anti gt (cat #))\nMicroscope : ________ (ex: Opera Phenix )\nMode : ________ (ex: Confocal)\nExcitation / emission details : ______________ (ex: ex 488 laser, em 550/50; ex 568 laser, em 600/30) (ex: see Index.idx.xml file)\nObjective : _____________ (ex: 20X water 1.0NA)\nBinning : ____________ (ex: 1x1)\nSites per well : __________ (ex: 9)\nPixel size : ____________ (ex: 0.656um)\nNumber of Z planes : _______ (ex: 3)\nZ plane spacing : ________ (ex: 1um)\n```\n\n\u003c/details\u003e\n\n## Data Access Instructions\n\n### Cloning the Repository\n\n```bash\ngit clone git@github.com:\u003corg\u003e/\u003crepo\u003e.git\n```\n\n### Downloading Data Files\n\n```bash\ncd \u003crepo\u003e\ndvc pull\n```\n\n### AWS configuration\n\nThe DVC cache is typically stored in an AWS S3 bucket, so you will need run `aws configure` before running `dvc pull`.\n\nIf the DVC location is not publicly accessible, you will need AWS credentials to access it.\n\nIf the DVC location is not publicly accessible, to access the files stored via DVC, you will need to created a IAM user with the `AmazonS3ReadOnlyAccess` policy attached:\n\n```json\n{\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"s3:Get*\",\n                \"s3:List*\",\n                \"s3-object-lambda:Get*\",\n                \"s3-object-lambda:List*\"\n            ],\n            \"Resource\": \"*\"\n        }\n    ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcytomining%2Fprofiling-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcytomining%2Fprofiling-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcytomining%2Fprofiling-template/lists"}