Comments (2)
Quick FYI: The documentation and sample repo have been merged in to the flepiMoP repo as of last week.
from flepimop.
Thanks for raising the issue. The multi-repo approach had some historical sense in the way this project was managed and what as public or not. Most of these requirements were removed.
Last week, we merged the sample_repo and the documentation within this main repository:
and we added an integration test for the examples. These changes still need to be reflected in the documentation (leaving this issue open until it's done).
There are still some open issues while consolidating: we want to keep the repository very light and without git-lfs. Our former version, COVIDScenarioPipeline, was several Gbs and cloning took several minutes, which is annoying as some batch jobs clone dozens of times on provisioned AWS instances. So what do we do about documentation assets and pictures ? and heavy notebooks? How do we teach folks how to use the USA repository if the sample repo is within flepiMoP (this is solved by having command line entry points).
The website being in a different repo makes sense to me, and very rarely do open-source projects have their website in the main repository (see e.g pytorch has https://github.com/pytorch/pytorch.github.io) especially when it's a github.io website.
Regarding the two websites, I agree that it would be ideal to have the documentation hosted in our own domain, but there are good arguments to let it be hosted on gitbook (search, non-static content, ease of development). Note that other packages (e.g https://xarray.dev) also open the documentation in another tab but in that case, it's a subdomain which is much nicer. Perhaps we could do something like this with gitbook. @clifmckee @shauntruelove who owns the flepimop.org domain ? We could have the documentation lie at docs.flepimop.org if you can add a specific CNAME entry to it (see https://docs.gitbook.com/publishing/custom-domain/configure-dns, happy to help).
Regarding the project structure, flepiMoP python's package gempyor follows it (https://github.com/HopkinsIDD/flepiMoP/tree/main/flepimop/gempyor_pkg) but right now the project is still a mix of R and python with the entry point written in R (that will hopefully change). The yngvem repo is 5y.o and the newer PEP guidelines for packaging are here: https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/ (linking specifically to this page on whether to name our package directory src
or flepiMoP
.
from flepimop.
Related Issues (20)
- Remove `path_prefix` Argument From `Parameters` Class HOT 2
- Document, Test, Repair `gempyor.parameters` Module HOT 2
- Split Up "unit-tests" GitHub Action Into Multiple Actions
- Add Python Code Linting For `gempyor`
- Improve Python Exception Readability/Consistency HOT 3
- Remove GitBook Deprecated/Old/Stub Pages HOT 3
- Document, Test, Repair `gempyor.subpopulation_structure` Module
- R inference error in calculating likelihood when data is missing/NA HOT 1
- `TestRunId.test_get_run_id_default_timestamp` Time Dependent Test Failure
- Convert `as_random_distribution` To Use `scipy.stats` Distributions HOT 1
- utils.py class `ISO8601Date` method `.convert()` has potentially unused argument `view`
- Using undefined parameter in a symbolic rate expression (transitions) slips thru input checks and results in uninformative error
- Transitions get overwritten if there are multiple of the same source->destination transitions HOT 3
- [Bug]: Using disease state names 'I1' and 'I2' only works when `proportional_to` are equal to "source" HOT 4
- [Bug]: Specifying a transition proportional to a sum of states only uses one of states included in the sum HOT 3
- [Bug]: `gempyor.statistics` Missing Documentation/Unit Tests HOT 3
- [Bug]: Disease state given to gempyor in a `proportional_to` with length greater than one, it gets cut off at a length of one and is interpreted further without warning HOT 2
- Normalization enforces homogeneous mixing across all model strata except spatial patch
- `utils.py` function `profile()` has potentially unused arguments `sort_by`, `lines_to_print`, and `strip_dirs` HOT 3
- Expanding `gempyor` unit testing framework to include exception checks HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from flepimop.