Joss paper #313
Joss paper #313
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #313 +/- ##
==========================================
+ Coverage 87.77% 87.79% +0.01%
==========================================
Files 22 22
Lines 2217 2220 +3
Branches 280 280
==========================================
+ Hits 1946 1949 +3
Misses 194 194
Partials 77 77 ☔ View full report in Codecov by Sentry. |
|
The structure is good. Just try to keep it below 1000 words. |
|
|
||
| `SWMManywhere` is an open-source Python package designed for the global synthesis of urban drainage networks. SWMManywhere integrates publicly available geospatial data and automates data acquisition and preprocessing, reducing the technical burden on users. The CLI offers a flexible workflow, providing an accessible entry point to using and customising synthesis. Its parameterized design enables detailed sensitivity analyses, allowing users to understand and manage uncertainties inherent in urban drainage modelling [@Dobson2024-dv]. By emphasizing user control, SWMManywhere allows tuning of outputs with parameters to meet local requirements, making it adaptable to a wide range of scenarios. Designed for both researchers and practitioners in urban water management, SWMManywhere responds to the limitations of existing methods by providing an end-to-end, open-source, and customisable solution. | ||
|
|
||
| ## Outlook |
There was a problem hiding this comment.
It feels odd that most of the paper talks about what it does not do, yet, rather than what it does, its unique features or what does better than other approaches. I know you do need to talk about this - and you phrased it very well as research opportunities rather than software limitations - but even so.
I would include a section on Features - or maybe as part of the statement of need - and a picture (maybe a map of the notebook with the calculated swage system) and reduce this section a little bit..
There was a problem hiding this comment.
good suggestions!
Description
(You can view it withNow a pdf that is compiled on publish.mkdocs serve)@cheginit this is a super quick draft I thought I'd prepare for a JOSS paper. I've just gone for something similar to the WSIMOD one. I haven't checked in detail at all and definitely need to polish it - but just wanted to check that you're happy with the broad format (i.e., summary = 1 para, statement of need = 1 para literature + 1 para software, outlook/limitations = 1 para). In particular I'm aware the literature para needs some significant improvement!
OK I've actually reduced it and moved the literature into the summary, but I think it works better, LMK what you think (@cheginit )
Fixes #337
Type of change
Key checklist
python -m pytest)python -m sphinx -b html docs docs/build)pre-commit run --all-files)Further checks