This repository holds various bits of code to make data analysis simpler.
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 serveThe 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
xsoftuser - 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 [email protected]:/home/xsoft