Skip to content

Welcome to the Imageomics Institute Guide!

This website hosts guides to Imageomics workflows, documentation, and general best-practices for collaborative science. We aim to provide a helpful resource for a broad base of scientists working in the field of imageomics and beyond.

It houses the information needed to get started with and use institute resources readily available to all members. However, most of this guide is applicable to anyone working more broadly in the field of imageomics or adjacent fields of computer and data science, and it is tailored to help domain scientists bridging that gap.

Highlights

There are many pages of useful information contained in this guide covering a range of topics from project management and workflows, to repositories and archives, to a glossary of imageomics-related terms for improved interdisciplinary communication.

Just starting a project?

Check out our guides to get your project off on the right foot!

  • The GitHub Repo Guide: This page reviews expected and suggested GitHub repository contents, as well as structural considerations.

  • The Hugging Face Repo Guide: Analogous expected and suggested repository contents for Hugging Face repositories; there are notable differences from GitHub in both content and structure.

  • Metadata Guide: Guide to metadata collection and documentation. This closely follows our HF Dataset Card Template sections.

Project repo up, what's next?

Check out our workflow guides for how to interact with your new repo:

  • The GitHub Workflow: This page mainly focuses on branching and the PR process.

  • The Hugging Face Workflow: Analogous workflow directions for Hugging Face; there are notable differences from GitHub in how this process works practically, though the concept is the same.

Project management or organization got you down?

Discover new tools to help:

  • Guide to GitHub Projects: This page focuses on GitHub's project management tool, Projects, which integrates issues and pull requests into a unified task board to keep tabs on how your project is progressing. Labels, milestones, and assignee tags provide improved organization, and allow for more focused views.

  • Helpful Tools for your Workflow: Collection of useful tools to facilitate and improve workflows. Comments and recommendations encouraged!

  • Virtual Environments: Summary of conda and pip environments: how to make, use, and share them.

Collaborative Infrastructure We Use

Collaborative Infrastructure Diagram

tech_infrastructure_diagram

Imageomics Branding (Logos)

We have two versions of the logo, a fish and a butterfly, which should be used for scientific posters, conference, workshop, and meeting marketing materials, etc. Choice of logo is based on user preference.

butterfly logo fish logo

Other pages of note

  • Glossary for Imageomics: Collection of terms used in imageomics. The goal is to ensure all participating domains are represented, thus facilitating interdisciplinary communication. This is a group effort, please check it out and add terms you think should be there!
  • Command Line Cheat Sheet: Collection of useful bash and git commands with some git tips.



Questions, Comments, or Concerns?