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

(JOSS) Paper Contents #121

Closed
fb456 opened this issue Feb 13, 2024 · 2 comments
Closed

(JOSS) Paper Contents #121

fb456 opened this issue Feb 13, 2024 · 2 comments

Comments

@fb456
Copy link

fb456 commented Feb 13, 2024

Hi,

In my opinion, there is no need to include the documentation Example in the paper's main body, despite it being very useful for the documentation.

I think it would be helpful to add a brief, high-level description of the workflow (in words instead of code, maybe even graphically ), possibly mentioning the types of data being dealt with in the input/output. More emphasis on who the software is directed towards, as well as its scope in terms of what it can do would also be useful. In addition, it could be good to further emphasise the software's differences compared to other similar ones.

In the Example, there are some useful paragraphs in between the code parts, which could be compiled and further developed to address some of the issues above.

Let me know if any of the above is unclear.

@cfarm6
Copy link
Member

cfarm6 commented Mar 15, 2024

@fb456 and @SotaYoshida Thank you. I have made updates to the paper to include a Use Case section for going over the highlights of the package and a section for comparisons with similar packages and features in other open-source and commercial programs

@fb456
Copy link
Author

fb456 commented Mar 16, 2024

Hi @cfarm6.

Thanks. I think the new version of the paper addresses the issues mentioned above.

@cfarm6 cfarm6 closed this as completed Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants