European XFEL toolkit for research and analysis
Project description
EXtra - European XFEL Toolkit for Research and Analysis
This repository holds various bits of code to make data analysis simpler.
Development
During development in a custom environment it's often helpful to install the package in editable mode:
$ pip install -e '.[tests,docs]'
Tests are stored under tests/
and use pytest:
$ python -m pytest .
The documentation is written using mkdocs with mkdocstrings-python. To automatically rebuild the docs while editing, run:
$ mkdocs serve
Deployment
The package is automatically deployed from master
every night into the current
exfel-python
environment using
the install-extra.sh
script (see the cron job with
crontab -e
as xsoft
on max-exfl-display001.desy.de
). The package is
installed with pip install --no-deps
to avoid causing conflicts with conda, so
if any dependencies need to be installed or updated that must be done with
conda. The install-extra.sh
script will check for new dependencies first and
return an error if dependencies need to be installed.
If you want to update it manually, you must follow these steps:
- SSH to Maxwell as the
xsoft
user - Run
./install-extra.sh
Note: make sure to update the copy in xsoft
's home directory if the script is
updated:
rsync -a --progress docs/install-extra.sh xsoft@max-exfl-display.desy.de:/home/xsoft
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for euxfel_EXtra-2024.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5514694a4df0abc6384a79776905e092411827c04821efe14a5ef677dc5eea40 |
|
MD5 | 8c08b4189694cdd617e118e54848408c |
|
BLAKE2b-256 | 89f542e1772c33f82547fe35935ec0dde6fc3bd4e059e67b6023dec1828cecd6 |