Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setting up TLOmodel for analysts (not installing the repo in editable mode) #1030

Open
tamuri opened this issue Jul 21, 2023 · 1 comment
Open
Assignees

Comments

@tamuri
Copy link
Collaborator

tamuri commented Jul 21, 2023

The current instructions are geared towards developers of the TLOmodel i.e. cloning the respository, installing it in editable mode, and special treatment of the root TLOmodel directory e.g. in the writing of output files.

This is not necessary for those running scenarios: TLOmodel could be installed as a normal Python package & scenario scripts and outputs sit somewhere else.

@tamuri tamuri changed the title Develop usage of TLOmodel by analyst - not on the repository in editable mode Setting up TLOmodel for analysts (not installing the repo in editable mode) Jul 21, 2023
@thewati thewati self-assigned this Apr 30, 2024
@thewati
Copy link
Collaborator

thewati commented May 24, 2024

Hi @tamuri, I have pushed a genanalysis.py file as a skeleton of the initial setup of the package. I wanted to check with you if this is also what you had in mind before I proceed. Below are some of the issues:

  1. Every analysis would have a function in the genanalysis.py file. This means an analyst (user) would just have to call the function of interest after running a pip install of the tlo model. For instance, the analyst would just call the function run_lifestlye_calibration in the genanalysis.py file to run analyses for the lifestlye module. Analyses for other modules would be run in a similar way (I would have to create functions for them).
  2. It seems there's another library on Pypi already called tlo. I thought it may not be able to deploy onto Pypi with a name already in use. Stumbled upon this while debugging.
  3. I am sure my naming of the files may not also be up to standard

I hope it all makes sense

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants