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

FElupe Submission #212

Open
22 of 32 tasks
adtzlr opened this issue Sep 14, 2024 · 16 comments
Open
22 of 32 tasks

FElupe Submission #212

adtzlr opened this issue Sep 14, 2024 · 16 comments
Assignees

Comments

@adtzlr
Copy link

adtzlr commented Sep 14, 2024

Submitting Author: Andreas Dutzler (@adtzlr)
All current maintainers: (@adtzlr)
Package Name: FElupe
One-Line Description of Package: Finite element analysis for continuum mechanics of solid bodies.
Repository Link: https://github.com/adtzlr/felupe
Version submitted: v9.0.0 v9.1.0 (updated on 2024-11-23)
EiC: @cmarmo
Editor: @tkoyama010
Reviewer 1: @nicoguaro
Reviewer 2: TBD
Archive: TBD
JOSS DOI: TBD
Version accepted: TBD
Date accepted (month/day/year): TBD


Code of Conduct & Commitment to Maintain Package

Description

  • Include a brief paragraph describing what your package does:

FElupe is a Python finite element analysis package focusing on the formulation and numerical solution of nonlinear problems in continuum mechanics of solid bodies. Easy-to-learn classes are provided to simulate the nonlinear deformation of hyperelastic solid bodies, see Getting Started. The constitutive material formulation of a hyperelastic solid body may be defined by its strain energy density function only (gradient and hessian are carried out by optional automatic differentiation). Strain energy functions for selected hyperelastic models are included. FElupe has only few dependencies, is a pure Python package but is also efficient enough for rubber-like structures. Several extension packages exist, e.g. to use a different automatic differentation backend or an interactive plot window.

grafik

Scope

  • Please indicate which category or categories.
    Check out our package scope page to learn more about our
    scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):

    • Data retrieval
    • Data extraction
    • Data processing/munging
    • Data deposition
    • Data validation and testing
    • Data visualization1
    • Workflow automation
    • Citation management and bibliometrics
    • Scientific software wrappers
    • Database interoperability

Domain Specific

  • Geospatial
  • Education

Community Partnerships

If your package is associated with an
existing community please check below:

  • For all submissions, explain how and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):

    • Who is the target audience and what are scientific applications of this package?

FElupe is great for teaching, scientific research as well as for mid-sized industry-problems related to the deformation of solid bodies. It has already been used in scientific articles which are listed in the README.

  • Are there other Python packages that accomplish the same thing? If so, how does yours differ?

Yes, there is scikit-fem, FEniCS, GetFEM and probably some others. While scikit-fem is definitely lightweight and easy-to-install, I found out that it is typically too slow for running hyperelastic simulations, e.g. the deformation of a rubber-like solid (see also my initial questions / posts in kinnala/scikit-fem#616). FEniCS on the other hand has a great community but the install-entry-barrier is much higher compared to a pure PyPI Python package. The same also applies for GetFEM, because both projects provide Python packages for their compiled code. I was looking for a more lightweight Python package but also efficient enough for simulating typical rubber-like structures. Hence, I started working on FElupe in 2021.

Instead of assembling general weak forms like scikit-fem and FEniCS, FElupe follows a more Abaqus-like UMAT (user material) approach for constitutive material formulations of solid bodies, see e.g. ConstitutiveMaterial or Hyperelastic.

  • If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted:

#211

Technical checks

For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:

  • does not violate the Terms of Service of any service it interacts with.
  • uses an OSI approved license.
  • contains a README with instructions for installing the development version.
  • includes documentation with examples for all functions.
  • contains a tutorial with examples of its essential functions and uses.
  • has a test suite.
  • has continuous integration setup, such as GitHub Actions CircleCI, and/or others.

Publication Options

JOSS Checks
  • The package has an obvious research application according to JOSS's definition in their submission requirements. Be aware that completing the pyOpenSci review process does not guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS.
  • The package is not a "minor utility" as defined by JOSS's submission requirements: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria.
  • The package contains a paper.md matching JOSS's requirements with a high-level description in the package root or in inst/.
    Note: Will be added soon - not present in the submitted v9.0.0. Edit: Added in v9.1.0 at paper/paper.md, a compiled PDF version of the draft is available here.
  • The package is deposited in a long-term repository with the DOI: https://zenodo.org/doi/10.5281/zenodo.4817406

Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.

Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?

This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.

  • Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Confirm each of the following by checking the box.

  • I have read the author guide.
  • I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.

Please fill out our survey

P.S. Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

The editor template can be found here.

The review template can be found here.

Footnotes

  1. Please fill out a pre-submission inquiry before submitting a data visualization package.

@lwasser lwasser moved this to pre-review-checks in peer-review-status Sep 14, 2024
@adtzlr adtzlr changed the title FElupe submission FElupe Submission Sep 14, 2024
@cmarmo cmarmo self-assigned this Sep 15, 2024
@cmarmo
Copy link
Member

cmarmo commented Sep 21, 2024

Editor in Chief checks

Hi @adtzlr! Thank you for submitting your package for pyOpenSci review.
Sorry to have kept you waiting!

Below are the basic checks that your package needs to pass to begin our review.
If some of these are missing, we will ask you to work on them before the review process begins.

Please check our Python packaging guide for more information on the elements below.

  • Installation The package can be installed from a community repository such as PyPI (preferred), and/or a community channel on conda (e.g. conda-forge, bioconda).
    • The package imports properly into a standard Python environment import package.
  • Fit The package meets criteria for fit and overlap.
  • Documentation The package has sufficient online documentation to allow us to evaluate package function and scope without installing the package. This includes:
    • User-facing documentation that overviews how to install and start using the package.
    • Short tutorials that help a user understand how to use the package and what it can do for them.
    • API documentation (documentation for your code's functions, classes, methods and attributes): this includes clearly written docstrings with variables defined using a standard docstring format.
  • Core GitHub repository Files
    • README The package has a README.md file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.
    • Contributing File The package has a CONTRIBUTING.md file that details how to install and contribute to the package.
    • Code of Conduct The package has a CODE_OF_CONDUCT.md file.
    • License The package has an OSI approved license.
      NOTE: We prefer that you have development instructions in your documentation too.
  • Issue Submission Documentation All of the information is filled out in the YAML header of the issue (located at the top of the issue template).
  • Automated tests Package has a testing suite and is tested via a Continuous Integration service.
  • Repository The repository link resolves correctly.
  • Package overlap The package doesn't entirely overlap with the functionality of other packages that have already been submitted to pyOpenSci.
  • Archive (JOSS only, may be post-review): The repository DOI resolves correctly.
  • Version (JOSS only, may be post-review): Does the release version given match the GitHub release (v1.0.0)?

  • Initial onboarding survey was filled out
    We appreciate each maintainer of the package filling out this survey individually. 🙌
    Thank you authors in advance for setting aside five to ten minutes to do this. It truly helps our organization. 🙌


Editor comments

Your package is already in great shape! Congratulation!
While my background is quite far from continuum mechanics of solid bodies, I particularly enjoyed the documentation and the graphical examples.

Here some clarifications about the unchecked boxes:

  • your README.md is very detailed but it is missing a link to the development instructions: in fact there are no development instructions in the documentation. Do you mind adding some? This will also allows you to link them in the CONTRIBUTING.md file.
  • Issue templates are not available in the .github repository: as your CONTRIBUTING.md clearly defines different kind of contributions, then issues, creating the templates will direct the contributor to the right type of feedback.
  • It looks like the majority of the links in the CONTRIBUTING.md gives a 404 not found error. Do you mind checking them?

Once those items are fixed we probably already have an editor for your submission... 🚀

@adtzlr
Copy link
Author

adtzlr commented Sep 21, 2024

Thank you very much @cmarmo for the basic checks and your detailed comments on what is missing. I'll enhance the mentioned files and add the missing issue templates.

Thank you also for your kind words on the docs ✍🏻! The graphical examples are implemented by PyVista for Sphinx and Sphinx-Gallery - its plot-directive is a really great feature.

... ⌛⌛⌛ ...

Note: All items are fixed! 🎉🎉🎉

  • The development install instructions are added to the docs and a link to it is added in README.md and CONTRIBUTING.md.
  • Issue templates are now available for bug reports and enhancement suggestions; questions are left unchanged as discussions (I'd like to keep them separated, this is now mentioned in CONTRIBUTING.md).
  • Links are fixed in CONTRIBUTING.md.

@cmarmo
Copy link
Member

cmarmo commented Sep 23, 2024

Thank you @adtzlr for your prompt reaction!
I am happy to announce that @tkoyama010 will serve as editor for your submission.
I am letting him introduce himself here and wishing a kind review process to everyone!

@lwasser lwasser moved this from pre-review-checks to under-review in peer-review-status Sep 23, 2024
@cmarmo cmarmo assigned tkoyama010 and unassigned cmarmo Sep 23, 2024
@adtzlr
Copy link
Author

adtzlr commented Oct 13, 2024

Thank you @tkoyama010 for taking your time to serve as an editor for this review, that's great 🥳 🚀. If you have any initial questions, please let me know!

@tkoyama010
Copy link
Member

@cmarmo I have completed the review by taking over your checklist. Please tell us the flow from here.

@cmarmo
Copy link
Member

cmarmo commented Oct 15, 2024

Thank you @tkoyama010 for following-up! Now the hard part will start... We need to look for reviewers for the package.
I have added you to the editor's Slack channel, so feel free to chat there: we can check in our pool of reviewers if some of them fit this package.

@adtzlr
Copy link
Author

adtzlr commented Oct 23, 2024

Hey @cmarmo and @tkoyama010!

In the meantime we prepared a draft paper 📝 for JOSS (meanwhile located in a private repo 🔒). Do you think it is okay to already include it in the FElupe-repo or better wait until the PyOpenSci review is finished?

Why do you require that the paper must be ...in the package root or in inst/? There are a lot of published papers which have their paper located at subfolders, like paper/paper.md (I checked a few of the latest published papers).

🙏🏻 Thank you! 🙏🏻

@cmarmo
Copy link
Member

cmarmo commented Oct 26, 2024

In the meantime we prepared a draft paper 📝 for JOSS (meanwhile located in a private repo 🔒). Do you think it is okay to already include it in the FElupe-repo or better wait until the PyOpenSci review is finished?

Please, add the paper to the repo, so our reviewers can have a look at it, this will speed up things for the JOSS submission.

Why do you require that the paper must be ...in the package root or in inst/? There are a lot of published papers which have their paper located at subfolders, like paper/paper.md (I checked a few of the latest published papers).

euh .... 🤔 I cannot find an explanation for that... I suggest you to follow JOSS requirements, while we clarify this.

Thank you!

@adtzlr
Copy link
Author

adtzlr commented Nov 23, 2024

Hi @tkoyama010, @cmarmo!

The draft for the FElupe JOSS-paper is ready and it is included in the repo paper/paper.md 📃 . Meanwhile, a compiled PDF is available here. A new version of FElupe is available since the initial submission, I've updated the submitted version from 9.0.0 to 9.1.0 - I hope this is fine. Feel free to switch back if needed!

@tkoyama010
Copy link
Member

@adtzlr Sorry about review process has been delayed. We are currently try to find reviewers. Please wait a little longer.

@adtzlr
Copy link
Author

adtzlr commented Nov 30, 2024

Thank you for the information @tkoyama010 - I'm looking forward to go through the review process ☕️.

@nicoguaro
Copy link

Hello @cmarmo, I think I can review this submission, but could you explain the process to me? Does it follow JOSS guidelines?

@tkoyama010
Copy link
Member

tkoyama010 commented Dec 4, 2024

Hello @cmarmo, I think I can review this submission, but could you explain the process to me? Does it follow JOSS guidelines?

@nicoguaro
Thank you for contacting. We will be happy to assign you as a reviewer. You might want to have a look to our review guide to have a better idea of our review process.
Also feel free to ask me any question if you need more details.

@tkoyama010
Copy link
Member

@nicoguaro
If you need help, we can also invite you to a private slack channel. In that case, please contact me with your email address at the email address in my profile.

@nicoguaro
Copy link

@tkoyama010, I think I have got it after reading the guide. If I have some question, I can ask them here.

I will start my review but it will take me some time since we are closing the semester and have a master thesis to review in my queue.

@nicoguaro
Copy link

nicoguaro commented Dec 7, 2024

@nicoguaro Package Review

Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide

  • As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor before starting your review).

Documentation

The package includes all the following forms of documentation:

  • A statement of need clearly stating problems the software is designed to solve and its target audience in README.
  • Installation instructions: for the development version of the package and any non-standard dependencies in README.
  • Vignette(s) demonstrating major functionality that runs successfully locally.
  • Function Documentation: for all user-facing functions.
  • Examples for all user-facing functions.
  • Community guidelines including contribution guidelines in the README or CONTRIBUTING.
  • Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere.

Readme file requirements
The package meets the readme requirements below:

  • Package has a README.md file in the root directory.

The README should include, from top to bottom:

  • The package name
  • Badges for:
    • Continuous integration and test coverage,
    • Docs building (if you have a documentation website),
    • A repostatus.org badge,
    • Python versions supported,
    • Current package version (on PyPI / Conda).

NOTE: If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the a badge for pyOpenSci peer-review will be provided upon acceptance.)

  • Short description of package goals.
  • Package installation instructions
  • Any additional setup required to use the package (authentication tokens, etc.)
  • Descriptive links to all vignettes. If the package is small, there may only be a need for one vignette which could be placed in the README.md file.
    • Brief demonstration of package usage (as it makes sense - links to vignettes could also suffice here if package description is clear)
  • Link to your documentation website.
  • If applicable, how the package compares to other similar packages and/or how it relates to other packages in the scientific ecosystem.
  • Citation information

Usability

Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole.
Package structure should follow general community best-practices. In general please consider whether:

  • Package documentation is clear and easy to find and use.
  • The need for the package is clear
  • All functions have documentation and associated examples for use
  • The package is easy to install

Functionality

  • Installation: Installation succeeds as documented.
  • Functionality: Any functional claims of the software been confirmed.
  • Performance: Any performance claims of the software been confirmed.
  • Automated tests:
    • All tests pass on the reviewer's local machine for the package version submitted by the author. Ideally this should be a tagged version making it easy for reviewers to install.
    • Tests cover essential functions of the package and a reasonable range of inputs and conditions.
  • Continuous Integration: Has continuous integration setup (We suggest using Github actions but any CI platform is acceptable for review)
  • Packaging guidelines: The package conforms to the pyOpenSci packaging guidelines.
    A few notable highlights to look at:
    • Package supports modern versions of Python and not End of life versions.
    • Code format is standard throughout package and follows PEP 8 guidelines (CI tests for linting pass)

For packages also submitting to JOSS

Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.

The package contains a paper.md matching JOSS's requirements with:

  • A short summary describing the high-level functionality of the software
  • Authors: A list of authors with their affiliations
  • A statement of need clearly stating problems the software is designed to solve and its target audience.
  • References: With DOIs for all those that have one (e.g. papers, datasets, software).

Final approval (post-review)

  • The author has responded to my review and made changes to my satisfaction. I recommend approving this package.

Estimated hours spent reviewing:


Review Comments

  • Pending

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: under-review
Development

No branches or pull requests

4 participants