Coder Social home page Coder Social logo

create a JOSS paper about pyro2 HOT 8 CLOSED

zingale avatar zingale commented on May 29, 2024
create a JOSS paper

from pyro2.

Comments (8)

zingale avatar zingale commented on May 29, 2024 1

for the research need, I think it is fair to say that this also serves as a platform for prototyping hydro methods, which fills a research need

from pyro2.

IanHawke avatar IanHawke commented on May 29, 2024

Here's a start on a checklist, based on their reviewer guidelines:

  • The paper itself
  • [ X ] Software license
  • Documentation
    • Statement of need (could argue this is done, but note that JOSS says "Your software should have an obvious research application" where they emphasize "obvious" but here I'd emphasize "research", as the current README statements are about "tutorial" and "self learning")
    • Installation instructions (should generalize? How much can be done via package management?)
    • Example usage (a lot of examples included in code: do they cover enough?)
    • API documentation (check docstring coverage, check "big picture" docs of core classes?)
    • Auto-build docs (as linked to issue #37), possibly using RTD?
  • Tests (with Travis on unit tests and regression tests could argue this is done)
  • Community guidelines
    • Contributing guidelines
    • Report issues or problems (should make this explicit)
    • [ X ] Seek support

from pyro2.

zingale avatar zingale commented on May 29, 2024

I'm checking tests -- we have pretty good coverage now.

from pyro2.

zingale avatar zingale commented on May 29, 2024

I've added a contributing doc

from pyro2.

IanHawke avatar IanHawke commented on May 29, 2024

Could argue that the contributing doc also covers how to report issues etc, so dealing with the Community guidelines section completely. Could make it fully explicit in the README via eg IanHawke@a93f544 .

from pyro2.

zingale avatar zingale commented on May 29, 2024

I've started a paper.md

from pyro2.

zingale avatar zingale commented on May 29, 2024

I think we are pretty much set for the JOSS submission. I just went through the docs. There are two unchecked items that we should look at. We should also formalize in the CONTRIBUTING.md what a significant contribution is, to gain authorship. We were thinking contributing a solver is an example, in which case we should reach out to the person who contributed the advection_nonuniform solver.

from pyro2.

IanHawke avatar IanHawke commented on May 29, 2024

This issue is now complete?

from pyro2.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.