Comments (8)
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.
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.
I'm checking tests -- we have pretty good coverage now.
from pyro2.
I've added a contributing doc
from pyro2.
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.
I've started a paper.md
from pyro2.
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.
This issue is now complete?
from pyro2.
Related Issues (20)
- make regression testing github action HOT 1
- Add a notice that the docs on readthedocs.io are outdated HOT 2
- Top-level `examples` module can break other packages
- store x2d and y2d as ArrayIndexer objects
- create axisymmetric grid class
- lm_atm-bubble regression test fails with numpy 1.24 HOT 5
- allow Pyro class to take name of function for initial conditions
- viscous burgers image is missing HOT 1
- "Latest release" on GitHub release page points at 2014 paper version HOT 1
- Setting PYTHONPATH is unnecessary? HOT 3
- Consider making pyro2 pip-installable HOT 3
- Consider adding support for pyro to yt
- Add _skeleton directory to help make new solvers/problems HOT 1
- add python 3.7 to testing
- well balanced scheme doesn't work anymore? HOT 1
- Error in terminal when animation is running and you click the animation
- Trouble implementing PLM reconstruction in C++ HOT 3
- Convert CI to GitHub actions
- add widget support to Jupyter notebooks HOT 3
- fix pyro setup.py installation HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pyro2.