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

Refactor/xwakes #8

Merged
merged 30 commits into from
Jun 21, 2024
Merged

Refactor/xwakes #8

merged 30 commits into from
Jun 21, 2024

Conversation

giadarol
Copy link
Member

@giadarol giadarol commented Jun 20, 2024

This repository contains the package that was previously hosted at https://gitlab.cern.ch/IRIS/pywit

Changes with respect to original repository:

  • Main package renamed from PyWIT to Xwakes.
  • Package published in PyPI (https://pypi.org/project/xwakes/)
  • Content originally under pywit moved to xwakes.wit.
    • pywit is kept as alias of xwakes.wit for backward compatibility.
  • Add xwakes/wit/materials.json to MANIFEST, so that the file is copied when installing with pip.
  • Create new setup.py identical to other Xsuite ones.
    • Dependencies and test dependences checked
    • pywit folder in the user's home is not created on installation but can be optionally created by running python -c 'import xwakes; xwakes.initialize_pywit_directory(). This is required only for using the IW2D interface. (README file updated accordingly).
  • Add release.sh script to make releases in PyPI.
  • Add Apache 2 license file (no change in conditions compared to license file in PyWIT, just a bit more explicit).
  • Existing CI workflow made compatible with GitHub and is now triggered automatically when a PR is created. This has been tested (tests are passing).
  • Tests involving IW2D are skipped by pytest when IW2D is not installed.
  • Only minor modifications to the code itself, namely:
    • Removed dependency on sortednp. See commit.
    • Handled a numpy array access warning. See commit.
    • Make matplotlib optional. See commit.
    • Replace numpy.trapz (deprecated in numpy 2.0) with numpy.trapezoid.

Prepared by @lgiacome and @giadarol.

@giadarol giadarol requested review from nmounet and lgiacome June 20, 2024 20:19
Copy link
Collaborator

@nmounet nmounet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

many thanks! just a few things I need to understand

LICENSE.txt Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
pywit/doit.py Outdated Show resolved Hide resolved
setup.py Outdated Show resolved Hide resolved
tests/test_utilities.py Show resolved Hide resolved
xwakes/wit/component.py Outdated Show resolved Hide resolved
tests/test_interface.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@lgiacome lgiacome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@lgiacome lgiacome merged commit 1fc05d8 into main Jun 21, 2024
1 check passed
Copy link
Collaborator

@nmounet nmounet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

excellent!

@giadarol giadarol deleted the refactor/xwakes branch August 9, 2024 07:40
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

Successfully merging this pull request may close these issues.

3 participants