[PRE REVIEW]: Interactive Geospatial Analysis and Visualization with MapX SDK: Connecting to the MapX Ecosystem

editorialbot commented 5 months ago

Submitting author: !--author-handle-->@fxi<!--end-author-handle-- (Frédéric Moser) Repository: https://github.com/unep-grid/mapx Branch with paper.md (empty if default branch): staging Version: 1.13.5-alpha.2 Editor: Pending Reviewers: Pending Managing EiC: Kristen Thyng

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/e30e49d3b05109727c8dd10eea3fe4a6"><img src="https://joss.theoj.org/papers/e30e49d3b05109727c8dd10eea3fe4a6/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/e30e49d3b05109727c8dd10eea3fe4a6/status.svg)](https://joss.theoj.org/papers/e30e49d3b05109727c8dd10eea3fe4a6)

Author instructions

Thanks for submitting your paper to JOSS @fxi. Currently, there isn't a JOSS editor assigned to your paper.

@fxi if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

editorialbot commented 5 months ago

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

editorialbot commented 5 months ago

Software report:

github.com/AlDanial/cloc v 1.90  T=1.47 s (1614.2 files/s, 360730.1 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
JSON                           118             44              0         331610
JavaScript                     404           8536          14629          66812
SQL                             98            438            695          60656
R                               71           2273           3082          12794
Markdown                        17           2144              0           6399
SVG                           1526             14             14           5111
LESS                            30             96             47           4435
CSS                             43            551            351           3921
HTML                            31             42             29           1411
XML                              2              2              0            589
Bourne Shell                    13            119            108            532
Dockerfile                       4             71             58            310
YAML                             2              5              3            248
Handlebars                       2             40              0            108
TeX                              1             14              0            101
CoffeeScript                     1             24              6             30
Scheme                           1              0              0              3
TypeScript                       1              0              0              1
-------------------------------------------------------------------------------
SUM:                          2365          14413          19022         495071
-------------------------------------------------------------------------------

Commit count by author:

  3077  fxi
    31  drikc
    26  Thomas Piller
    25  antobenve
    11  WT
    10  MarionPlanque
     6  Antonio
     5  thomaspiller
     4  alejandraarango
     3  AlbertMase
     3  GianlucaGygax
     2  Antonio Benvenuti
     2  F.Moser
     1  Khaled Basbous
     1  Pierre Lacroix, PhD
     1  dependabot[bot]

editorialbot commented 5 months ago

Paper file info:

📄 Wordcount for paper.md is 1283

✅ The paper includes a Statement of need section

editorialbot commented 5 months ago

:warning: An error happened when generating the pdf.

editorialbot commented 5 months ago

License info:

🟡 License found: Other (Check here for OSI approval)

kthyng commented 5 months ago

Hi @fxi and thanks for your submission! I am looking for some specific items to make sure your submission fits our requirements at a high level (not at the more detailed review level) before moving on to finding an editor or putting this on our waitlist if no relevant editors are available. I'll comment over time as I have a chance to go through them:

[ ] Substantial scholarly effort
[ ] Documentation
[x] Tests of some sort
[ ] Installation instructions
[ ] Clear research application
[ ] Check paper
[ ] License

In the meantime, please take a look at the comments above ⬆️ from the editorialbot to address any DOI, license, or paper issues if you're able (there may not be any), or suggest reviewers. For reviewers, please suggest 5 reviewers from the database listed above or your own (non-conflicted) extended network. Their github handles are most useful to receive but please don't use "@" to reference them since it will prematurely ping them.

kthyng commented 5 months ago

Please check out error in paper building
Can a user install without using docker and if so where are those instructions?
Are there docs?

fxi commented 5 months ago

Hi!

We will check that as soon as possible.

Quick comments:

The paper was built using the Docker compiler without obvious issue, but the path should probably be adjusted. Maybe we missed something in the instructions or we made a mistake. We will have a look at the action log.
What is submitted is only the package related to the SDK of MapX, not MapX itself, which is a multi-service app available through Docker, with various licenses. MapX itself is probably not interesting for a JOSS submission. The SDK should be under a single license, and that's what the article is about.
The docs:
- MapX SDK doc Instructions are a bit outdated and will be improved / streamlined.
- MapX doc
- MapX project

kthyng commented 5 months ago

MapX SDK doc Instructions are a bit outdated and will be improved / streamlined.

When do you plan to improve the docs?

Can a user install MapX SDK without Docker?

kthyng commented 5 months ago

@fxi Since this is a web application, I will ping the editorial board to check if it is in scope for JOSS. This will take a few weeks, thanks for your patience.

kthyng commented 5 months ago

@editorialbot query scope

editorialbot commented 5 months ago

Submission flagged for editorial review.

kthyng commented 5 months ago

@openjournals/dev Could you take a look to see why the paper isn't building here?

xuanxu commented 5 months ago

The compilation fails because the paper's metadata includes a wrongly formatted date value:

date: 2024-04-11

should be:

date: 11 April 2024

kthyng commented 5 months ago

@xuanxu Thank you very much!

@fxi Can you please fix this?

fxi commented 5 months ago

@kthyng I'll look at that soon, sorry for the delay, thanks for your patience. Thanks @xuanxu, for your input.

danielskatz commented 5 months ago

@editorialbot generate pdf

editorialbot commented 5 months ago

:warning: An error happened when generating the pdf.

danielskatz commented 5 months ago

@fxi - please remove paper.jats from your repo, as we need to build it, and our script seems to fail if it already exists. You could also remove paper.pdf, though I think our script does not fail due to this.

👋 @xuanxu - should we handle this better?

xuanxu commented 5 months ago

yes, this error is caused by the presence of a JATS metadata file (paper.jats) in the folder where the paper is. The bot is in charge of generating that file so it bot stops with an error if it's already there. Deleting or just renaming it should do.

@danielskatz yes, we could overwrite it, or create our file with a more obscure name so the chances of a conflict is smaller, but I guess we'd still want at least a warning, the presence of that metadata file could be misleading.

fxi commented 5 months ago

🙏 Thanks. I've added that to a local .gitignore

[edit : removed @editorialbot generate pdf command : apparently misunderstood how that works ]

danielskatz commented 4 months ago

@editorialbot generate pdf

editorialbot commented 4 months ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

kthyng commented 4 months ago

@fxi Sorry for the delay. Unfortunately the editorial board has found this submission to be out of scope for JOSS. While the software looks very useful, we don't find the argument to be made for it as research software which is a core part of our mission at JOSS.

For what it's worth, we are also working on clarifying our guidelines for web applications: https://joss.readthedocs.io/en/latest/submitting.html#a-note-on-web-based-software.

We do also provide a few suggestions for other avenues for publishing your software: https://joss.readthedocs.io/en/latest/submitting.html#a-note-on-web-based-software

Thank for your interest in JOSS.

kthyng commented 4 months ago

@editorialbot reject

editorialbot commented 4 months ago

Paper rejected.

openjournals / joss-reviews

[PRE REVIEW]: Interactive Geospatial Analysis and Visualization with MapX SDK: Connecting to the MapX Ecosystem #6650

Status