Updated the emod-hub docs landing page#4
Conversation
Bridenbecker
left a comment
Bridenbecker
left a comment
There was a problem hiding this comment.
If this is landing page, then I think it should be focused on directing people on where they might want to go. There should be package links in the margins, but not in the body. There could be disease links in the margins for returning users, but the body should probably focus on new people/Getting Started.
I also need to talk to Rajiv about what IDM is going to do versus just saying it is dead.
| Homepage for documentation. | ||
| !!! warning "EMOD is no longer under active development" | ||
|
|
||
| EMOD will not receive new features, bug fixes, or model updates. Community support is available through the GitHub Discussions forum, and model code will remain publicly accessible. We recommend evaluating whether EMOD is the right fit before starting new work. |
There was a problem hiding this comment.
I'm struggling with this statement. We are still supporting our internal researchers when they need changes to EMOD. Svetlana has been making changes for Prashanth.
More importantly for outside communication, there is the issue of PRs. Do we take them? Bigger. What will IDM do? Will we participate in the discussion board? Will we review and merge PRs? If someone else wants to make changes, how?
What about ownership? If IDM isn't doing anything, can someone else? Should we give people at NYU and AHADI write/admin access?
These are above your pay grade. I need to bring it up with Rajiv. Just know that I don't think we have this figured out yet.
|
|
||
| ## Available models and utilities | ||
|
|
||
| We provide both modeling software and workflow tools to support an end-to-end simulation pipeline. EMOD is the disease model framework, offering disease-specific models for malaria and HIV alongside Python packages for configuring and running simulations. idmtools is a model-agnostic framework that handles the surrounding infrastructure: job commissioning, HPC integration, calibration, and more. While each can be used independently, we recommend using them together for a seamless, integrated workflow. |
There was a problem hiding this comment.
I would remove the first sentence. We purposely do not have tons of IDM branding on EMOD-Hub.
|
|
||
| [:octicons-arrow-right-24: idmtools_calibra](https://institutefordiseasemodeling.github.io/idmtools-calibra/) | ||
|
|
||
| </div> |
There was a problem hiding this comment.
instead of being nitpicky about particular wording, I think we need to step back and look at the big picture. If this is the landing page, people need direction on where to go. I like the idea of three/four options:
- Overview / What is EMOD / Documentation
This could be some of what you have here plus other stuff you have written over the years. - Getting Started - Malaria
I'm not good at this, but maybe a page with links to documentation about the malaria model, maybe a link to my malaria tutorial, maybe a link to installation - Getting Started - HIV
This one is more tricky since we have two starting locations. emodpy-hiv has some tutorials, but we have the majority of getting started documentation in emodpy-workflow. And I might have just created a third for old EMOD-HIV users that can't quite go to emody-workflow. - Getting Started - Measles
@kfrey-idm needs to decide if he wants to advertise this more.
I think we want to avoid just sending people to random package documentation because that would mean they understand everything. For example, I would never send a user to look at emod-api unless I had no other choice. I don't even want them looking at emodpy if I can help it. They should really be going to emodpy-malaria or emodpy-hiv/emodpy-workflow.
One thing that probably needs more visibility is how to use the Container platform of idmtools. This requires installing things like Docker Desktop. I don't even know where to go for the installation instructions. They are probably buried in idmtools somewhere.
No real time to do all of this. Probably best to create links to the limited stuff we already have.
|
emodpy-hiv tutorials - could be run in Codespaces emodpy-workflow Getting Started emodpy-malaira tutorial - could be run in Codespaces Maybe a link to the Faculty Enrichment Program training material |
|
Content reproduced in #5 |
3 participants
Please feel free to change or add text! This is meant as a starting point to get the emod-hub docs squared away.