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.

Sign up for GitHub

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

DOC: update readme, add back in button to see github-actions result #23

Merged
merged 1 commit into from
Feb 20, 2024
Merged

DOC: update readme, add back in button to see github-actions result #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# beamtime-calibration-suite
[![Build Status](https://github.com/slaclab/beamtime-calibration-suite/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/slaclab/beamtime-calibration-suite/actions/workflows/run-tests.yml)

To run any suite_scripts or use the library in scripts outside the project directory, you need to append the location of your project directory to your PYTHONPATH, for example:
```
export PYTHONPATH="${PYTHONPATH}:~/nolan/repos/beamtime-calibration-suite"
Expand All @@ -21,6 +24,8 @@ _(documentation on the library functionality is still to come, but example usage
* /tests: tests files, can be ran with 'pytest .' from the root project directory
_(Currently only test for the fitFunctions library file is running, more tests are to be added)_

* /data: misc data files from the rixx1003721 scripts directory, saving for now but most files will probably be deleted later

## Current Status:

main branch tag v1.0.0 are the scripts used for the 2/17/24 beamtime
Expand Down