easy-plot-beamline 0.2.0rc0

Citation

If you use easy-plot-beamline in a scientific publication, we would like you to cite this package as

easy-plot-beamline Package, https://github.com/cadenmyers13/easy-plot-beamline

Installation

Use pip to download and install the latest release from Python Package Index. To install using pip into your easy-plot-beamline_env environment, type

pip install easy-plot-beamline

If you prefer to install from sources, after installing the dependencies, obtain the source archive from GitHub. Once installed, cd into your easy-plot-beamline directory and run the following

pip install .

This package also provides command-line utilities. To check the software has been installed correctly, type

easy-plot-beamline --version

You can also type the following command to verify the installation.

python -c "import easy_plot_beamline; print(easy_plot_beamline.__version__)"

To view the basic usage and available commands, type

easyplot -h

Getting Started

Once installed, you can use the easyplot CLI. Type -h to see the available commands for all subcommands.

easyplot -h
easyplot plot -h
easyplot waterfall -h
easyplot diff -h
easyplot diffmatrix -h

Here are some example usages:

# plot data overlaid
easyplot plot file.gr file.txt ...
# plot waterfall plot
easyplot waterfall file.gr file.txt ...
# plot difference between two datasets
easyplot diff file1.gr file2.gr
# plot difference matrix of multiple datasets
easyplot diffmatrix file1.gr file2.gr ...

Support and Contribute

If you see a bug or want to request a feature, please report it as an issue and/or submit a fix as a PR.

Feel free to fork the project and contribute. To install easy-plot-beamline in a development mode, with its sources being directly used by Python rather than copied to a package directory, use the following in the root directory

pip install -e .

To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit hooks.

1. Install pre-commit in your working environment by running conda install pre-commit.

2. Initialize pre-commit (one time only) pre-commit install.

Thereafter your code will be linted by black and isort and checked against flake8 before you can commit. If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before trying to commit again.

Improvements and fixes are always appreciated.

Before contributing, please read our Code of Conduct.

Contact

For more information on easy-plot-beamline please visit the project web-page or email Caden Myers at cjm2304@columbia.edu.

Acknowledgements

easy-plot-beamline is built and maintained with scikit-package.