Skip to content

Imageomics-focused guide to collaborative work, including GitHub and Hugging Face workflows.

License

Notifications You must be signed in to change notification settings

Imageomics/Imageomics-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Imageomics Guide

Welcome to the Imageomics Guide!

Just joining or starting a new project? Checkout the Imageomics Guide for guidance on conventions and best practices.

About the Guide

This guide started as an Institute-internal wiki, focused on providing guidance and best practices for collaborative and interdisciplinary (computer science + biology) work. Recognizing that the topics and suggestions are broadly applicable to anyone working in similar or adjacent fields, we moved the vast majority to this guide. To increase accessibility for those less familiar with GitHub, we generated the web site from our Markdown documents (which used to be wiki pages) with Material for MkDocs.

Please feel free to open an issue with any questions regarding the content fo this guide or if you would like to contribute to the Glossary or Helpful Tools page.

Testing

To test this site locally, first clone this repository, then create an environment with requirements.txt

pip install -r requirements.txt

and run mkdocs serve:

mkdocs serve

Then the site will run at http://127.0.0.1:8000/Imageomics-guide/.