Description: The gEAR Portal was created as a data archive and viewer for gene expression data including microarrays, bulk RNA-Seq, single-cell RNA-Seq and more. Initially created for the hearing research community, instances of the gEAR have been cloned for other communities such as brain research.
Other things to include:
- Technology stack: The gEAR software is a LAMP stack utilizing Python and MySQL, H5AD for large expression matrix storage, D3 and Plot.ly for data visualization and has embedded Gosling support to display epigenetic data.
- Status: This project has been in production for several years, though is in constant development so bugs certainly exist.
- Production / Demo instances
- UMgEAR - Portal for hearing research
- NeMO Analytics - Portal for brain research
Screenshot: Example of home page after searching for a gene:
Setting up your own portal is admittedly a bit of work. There are a lot of components to the portal and running on a server with at least 16 cores and 100GB+ of RAM is recommended. The process is documented in the Developer Documentation.
For detailed setup instructions, see:
- Server Setup Guide - Complete installation guide
To learn how to use the software you can go to any existing portal and click the documentation link at the top, which will take you to a page like this one. It has walk-through slides and YouTube videos for most topics.
For developers and team members working on gEAR:
-
Developer Guide - Main developer documentation
- Architecture overview
- Development workflow
- Code style guidelines
- Common tasks
-
Setup Guides - Server installation and configuration
- New server setup
- Component-specific guides (MySQL, Apache, Python, R, RabbitMQ)
- Docker development environment
-
Utility Scripts - Documentation for 105+ scripts in
/bin- Data conversion and format scripts
- H5AD manipulation tools
- Database loading scripts
- Validation and testing utilities
- Dataset management tools
-
Microservices - Service documentation
- ProjectR service (matrix projection)
- Spatial panel service
- RabbitMQ consumers
This repository was hosted private for many years and we have just recently transitioned to this new public one. If you find any issues, please use the Issue tracker here in GitHub to see if the problem is already reported or create your own ticket.
There are a few ways to get help with a gEAR Portal.
- Check the provided documentation.
- Use the contact form at the top of any existing portal. Here, for example.
- Submit a ticket on the issue tracker
If you'd like to contribute to the gEAR in any form (documentation, bug fixes, new features, etc.) just fork the project and create a pull request. Within the project, we follow this branching model.
The gEAR is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE V3 For more info, see the LICENSE document.
