[PRE REVIEW]: Emiproc: A Python package for emission inventory processing

[editorialbot]

Submitting author: @lionel42 (Lionel Constantin)
Repository: https://github.com/C2SM-RCM/emiproc
Branch with paper.md (empty if default branch): joss
Version: v2.1
Editor: @mengqi-z
Reviewers: @dostuffthatmatters, @einaraz
Managing EiC: Arfon Smith

Status

Status badge code:

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

Author instructions

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

@lionel42 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]

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]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.5194/gmd-13-2379-2020 is OK
- 10.5281/zenodo.3946761 is OK
- 10.1109/MCSE.2007.55 is OK
- 10.2800/795737 is OK
- 10.35089/WDCC/IconRelease01 is OK
- 10.5194/gmd-12-1885-2019 is OK
- 10.5194/gmd-13-873-2020 is OK
- 10.5194/acp-24-2759-2024 is OK
- 10.5194/egusphere-egu24-3375 is OK
- 10.5194/egusphere-egu24-7420 is OK
- 10.1029/2006GB002735 is OK
- 10.5194/gmd-11-4043-2018 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: EDGAR (Emissions Database for Global Atmospheric R...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.12 s (1333.7 files/s, 165288.6 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          90           2487           2838          10278
CSV                             27              2              0            501
Jupyter Notebook                 4              0            893            461
reStructuredText                11            372            187            405
Markdown                         4             71              0            201
YAML                            13             13             22            172
TeX                              1              9              0            170
TOML                             1              9              0             52
DOS Batch                        1              8              1             26
make                             1              4              7              9
JSON                             1              0              0              8
SVG                              1              0              1              3
-------------------------------------------------------------------------------
SUM:                           155           2975           3949          12286
-------------------------------------------------------------------------------

Commit count by author:

   267	coli
    81	Ochsner, David
    69	Gerrit Kuhlmann
    50	Haussaire JM
    33	Constantin, Lionel
    32	Michael Jähn
    21	efmkoene
    16	Jean-Matthieu Haussaire
    12	lionel constantin
    11	Dominik Brunner
     6	Lionel C
     4	Haussaire, Jean-Matthieu
     3	David Ochsner
     2	Jaehn, Michael
     2	dao
     2	jmhaussaire
     1	Joel Thanwerdas
     1	Kuhlmann, Gerrit
     1	Michael Steiner
     1	corink21
     1	gredvis

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1771

✅ The paper includes a Statement of need section

[editorialbot]

License info:

🔴 License found: Creative Commons Attribution 4.0 International (Not OSI approved)

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[editorialbot]

Five most similar historical JOSS papers:

HydroMT: Automated and reproducible model building and analysis
Submitting author: @dirkeilander
Handling editor: @elbeejay (Active)
Reviewers: @JannisHoch, @mcflugen, <s>@LejoFlores</s>
Similarity score: 0.6504

PyHeatDemand - Processing Tool for Heat Demand Data
Submitting author: @AlexanderJuestel
Handling editor: @timtroendle (Retired)
Reviewers: @nmstreethran, @samuelduchesne
Similarity score: 0.6449

Pyinterpolate: Spatial interpolation in Python for point measurements and aggregated datasets
Submitting author: @SimonMolinsky
Handling editor: @hugoledoux (Active)
Reviewers: @chrisbrunsdon, @kenohori, @sdesabbata
Similarity score: 0.6407

EmissV: an R package to create vehicular and other emissions for air quality models
Submitting author: @Schuch666
Handling editor: @arfon (Active)
Reviewers: @nuest, @benmarwick
Similarity score: 0.6351

GridFormat: header-only C++-library for grid file I/O
Submitting author: @dglaeser
Handling editor: @danielskatz (Active)
Reviewers: @lukeolson, @IgorBaratta
Similarity score: 0.6335

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[arfon]

@lionel42 – thanks for your submission to JOSS. We're currently managing a large backlog of submissions and the editor most appropriate for your area is already rather busy.

For now, we will need to waitlist this paper and process it as the queue reduces. Thanks for your patience!

🔴 License found: Creative Commons Attribution 4.0 International (Not OSI approved)

Just noting that this seems to be an error on our part – my checking of the repository shows a BSD license so I think there's nothing to do here.

[lionel42]

License info:

🔴 License found: Creative Commons Attribution 4.0 International (Not OSI approved)

This is not correct. We have changed the licence to a BSD-3 licence for the new package update
See
https://github.com/C2SM-RCM/emiproc/blob/master/LICENSE.txt

[kthyng]

Hi @lionel42 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:

• OSI-approved license
• Installation instructions
• Documentation exists at all
• Tests of some sort
• Check paper (make sure compiles, read through, check for length 250-1000 words)
• Substantial scholarly effort
• Clear research application

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]

@lionel42

• Can this be released to PyPI?
• Please reduce to length of your paper to up to about 1000 words (it is about 1770 words currently). Paper format information here: https://joss.readthedocs.io/en/latest/paper.html
• In your paper, please check that your inline vs. parenthetical references are correct. You can compare with the example paper here: https://joss.readthedocs.io/en/latest/example_paper.html

[lionel42]

@kthyng Thanks for the feedback

* Can this be released to PyPI?

Yes, I just setup the github action to release to pypi: https://pypi.org/project/emiproc/#description

* Please reduce to length of your paper to up to about 1000 words (it is about 1770 words currently). Paper format information here: https://joss.readthedocs.io/en/latest/paper.html

I have reduced the size of some sections. Is there a possibility to trigger the bot again to count the words now ?

* In your paper, please check that your inline vs. parenthetical references are correct. You can compare with the example paper here: https://joss.readthedocs.io/en/latest/example_paper.html

I am not sure I understand this point, the references look okay for me.

[lionel42]

For reviewers I would suggest:

• https://github.com/jcla490
• https://github.com/rwegener2
• https://github.com/dostuffthatmatters (in my non-conflicted extended network)
• https://github.com/einaraz
• https://github.com/varsha2509
• https://github.com/ibarraespinosa (same field, but in R and not python, not sure if that is okay for review)

[kthyng]

Yes, I just setup the github action to release to pypi: https://pypi.org/project/emiproc/#description

Great! I see it there. Please update your installation instructions too.

[kthyng]

@editorialbot check repository

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.90  T=0.16 s (1163.5 files/s, 182855.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                         103           3303           3407          13090
Jupyter Notebook                13              0           5964           1254
CSV                             27              2              0            502
reStructuredText                21            437            224            483
YAML                            13             13             22            172
TeX                              1              9              0            170
Markdown                         4             55              0            150
TOML                             1              9              0             57
DOS Batch                        1              8              1             26
make                             1              4              7              9
JSON                             1              0              0              8
SVG                              1              0              1              3
-------------------------------------------------------------------------------
SUM:                           187           3840           9626          15924
-------------------------------------------------------------------------------

Commit count by author:

   445	coli
    81	Ochsner, David
    69	Gerrit Kuhlmann
    50	Haussaire JM
    39	Constantin, Lionel
    32	Michael Jähn
    21	efmkoene
    16	Jean-Matthieu Haussaire
    13	lionel constantin
    12	Lionel C
    11	Dominik Brunner
     4	Haussaire, Jean-Matthieu
     3	David Ochsner
     2	Jaehn, Michael
     2	dao
     2	jmhaussaire
     1	Joel Thanwerdas
     1	Kuhlmann, Gerrit
     1	Michael Steiner
     1	corink21
     1	gredvis

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 1133

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

[kthyng]

I am not sure I understand this point, the references look okay for me

An an example, line 27 has the reference in parentheses but it shouldn't be.

As per the new comments, the paper length is now 1133. If you can shorten a little more that would be great, but if not, it is close enough.

[lionel42]

Great! I see it there. Please update your installation instructions too.

Here it is: installation with pip:

https://emiproc.readthedocs.io/en/master/installation.html

[lionel42]

An an example, line 27 has the reference in parentheses but it shouldn't be.

As per the new comments, the paper length is now 1133. If you can shorten a little more that would be great, but if not, it is close enough.

I removed the parenthesis around citations where I understood they were not required.

Also I removed a bit more words. We are still above 1000 but I don't see where I could reduce more. I guess we can decide later based on the reviewer's comments.

[kthyng]

@editorialbot generate pdf

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[editorialbot]

Five most similar historical JOSS papers:

MetObs - a Python toolkit for using non-traditional meteorological observations
Submitting author: @vergauwenthomas
Handling editor: @hugoledoux (Active)
Reviewers: @ashwinvis, @Zeitsperre
Similarity score: 0.7223

elmada: Dynamic electricity carbon emission factors and prices for Europe
Submitting author: @mfleschutz
Handling editor: @fraukewiese (Active)
Reviewers: @nmstreethran, @olejandro
Similarity score: 0.7217

eixport: An R package to export emissions to atmospheric models
Submitting author: @ibarraespinosa
Handling editor: @leeper (Retired)
Reviewers: @jhollist
Similarity score: 0.7214

3dfier: automatic reconstruction of 3D city models
Submitting author: @hugoledoux
Handling editor: @arfon (Active)
Reviewers: @GANys, @chenkianwee
Similarity score: 0.7177

autumn: A Python library for dynamic modelling of captured CO_2 cost potential curves
Submitting author: @Eugenio2192
Handling editor: @timtroendle (Retired)
Reviewers: @igarizio, @milicag
Similarity score: 0.7171

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[lionel42]

@kthyng What would be the next steps for the review ? Is it to contact reviewers ? #7337 (comment)

[kthyng]

@lionel42 Ah sorry I thought I had wrapped up the checklist already. No, the next step is to find your editor, which you are already on the waitlist for. Thanks.

[kthyng]

@mengqi-z Can you edit this submission?

[kthyng]

@editorialbot invite @mengqi-z as editor

[editorialbot]

Invitation to edit this submission sent!

[mengqi-z]

@editorialbot assign me as editor

[editorialbot]

Assigned! @mengqi-z is now the editor

[mengqi-z]

Hi @lionel42, I will be the handling editor of your submission. Once we secure at least two reviewers, we’ll begin the review process. Please don’t hesitate to reach out if you have any questions at any point. Thank you!

[mengqi-z]

👋 @jcla490 @dostuffthatmatters @einaraz - Would any of you be available to review this submission for JOSS? JOSS uses a checklist-driven review process, which you can find here: https://joss.readthedocs.io/en/latest/review_criteria.html

[dostuffthatmatters]

Hi @mengqi-z ,

Yes, I am happy to review it!

[mengqi-z]

@dostuffthatmatters - Wonderful! Thanks so much!

[mengqi-z]

@editorialbot add @dostuffthatmatters as reviewer

[editorialbot]

@dostuffthatmatters added to the reviewers list!

[einaraz]

Hi @mengqi-z, thanks for the invite! I would be happy to review it as well!

[mengqi-z]

@einaraz - Thank you for taking on this review!

[mengqi-z]

@editorialbot add @einaraz as reviewer

[editorialbot]

@einaraz added to the reviewers list!

[mengqi-z]

@editorialbot start review

[editorialbot]

OK, I've started the review over in #7509.