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

Integration of xplt into xsuite #5

Closed
5 tasks done
eltos opened this issue Feb 20, 2024 · 5 comments
Closed
5 tasks done

Integration of xplt into xsuite #5

eltos opened this issue Feb 20, 2024 · 5 comments

Comments

@eltos
Copy link
Member

eltos commented Feb 20, 2024

Following discussions with @giadarol and @eltos last week, we want to add xplt to the xsuite collection

  • Clarify preconditions / responsibilities (see below, by @giadarol @eltos @rdemaria @szymonlopaciuk)
  • Add @eltos to github.com/xsuite group (by @giadarol, at least temporary to allow moving the repo there)
  • Move repository github.com/eltos/xplt to github.com/xsuite/xplt (by @eltos)
  • Add @giadarol and @rdemaria as maintainer on PyPI (by @eltos, deployment is fully automated via GitHub action, but just in case)
  • Update xsuite examples and documentation to use xplt plots

I have added some guidelines and core concept description of xplt at https://github.com/eltos/xplt/wiki

Some things to clarify (we talked about it, but just to be sure)

  • @eltos will keep using and updating the library for his daily needs, likely on a separate branch and merging, publishing versions etc. in the short term
  • @giadarol will keep the library working with future updates / possible API changes of xsuite in the long term
  • On short term, the existing basic functionality remains somewhat independent of xsuite (i.e. no imports), since many of the spill and slow extraction related plots work and are being used with data from different sources (including detector data from measurements) and e.g. floor plan plotting of a sequence before/after conversion from MAD-X is useful

    As from the docs:
    Xsuite is not an explicit dependency, rather an API assumption on available attributes, indices and units. You can use data from any source, and also custom attributes. See examples/properties on how to specify units of custom attributes.

  • New functionality can rely on xsuite specific implementation details when required
  • Automated testing is currently done only by checking for exceptions, not by image comparison of actual output.
@eltos
Copy link
Member Author

eltos commented Feb 20, 2024

@giadarol do you agree? Anything to add?

@szymonlopaciuk
Copy link

@eltos I have added you to the organisation. Once you request the transfer of Xplt (Settings > General > Danger Zone) we will approve it and make sure the permissions are set up right so that you can manage it.

@eltos
Copy link
Member Author

eltos commented Apr 16, 2024

@szymonlopaciuk looks good, PYPI tokens have been transferred, release action is working, docs are online at https://xsuite.github.io/xplt

@szymonlopaciuk
Copy link

Perfect! I've made you admin on the repository, so you should retain all the rights that you've had so far.

@eltos
Copy link
Member Author

eltos commented Apr 16, 2024

Added a first example to the docs, see xsuite/xtrack#477 and xsuite/xsuite#487

@eltos eltos closed this as completed Apr 16, 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