From c40138d5fdff3cae8ff9463b8660afb8fc0f9157 Mon Sep 17 00:00:00 2001 From: nstelter-slac Date: Tue, 20 Feb 2024 13:25:11 -0800 Subject: [PATCH] DOC: Update readme and make more readable --- README.md | 54 +++++++++++++++++++++++++----------------------------- 1 file changed, 25 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index d2bca4a..0caea19 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,35 @@ -# 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" +``` +_(can add this to your ~/.bashrc so persists between terminal sessions. Library can later have a better release method than cloning and adding to path (pip?))_ -To run any suite_scripts or use the library in scripts outside the project directory, you need to append the project directory to your PYTHONPATH, for example: -export PYTHONPATH="${PYTHONPATH}:~/beamtime_slaclab/beamtime-calibration-suite" +## File organization: +* /calibrationSuite: The library code lives here, and the functions can be imported into other scripts as such: +``` + from calibrationSuite.basicSuiteScript import * + from calibrationSuite.fitFunctions import * + from calibrationSuite.Stats import * + from calibrationSuite.cluster import * +``` +_(documentation on the library functionality is still to come, but example usage is seen in the /suite_scripts folder)_ -(can add this to your ~/.bashrc so persists between terminal sessions. Library can later have -a better release method than cloning and adding to path (pip?)) +* /suite_scripts: scripts that use the calibrationSuite library code -File organization: -/calibrationSuite: The library code lives here, and the functions can be imported into other scripts as such: +* /standalone_scripts: scripts that do not use the calibrationSuite library code -from calibrationSuite.basicSuiteScript import * -from calibrationSuite.fitFunctions import * -from calibrationSuite.Stats import * -from calibrationSuite.cluster import * +* /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)_ -(documentation on the library functionality is still to come, but example usage is seen in the /suite_scripts folder) - -/suite_scripts: scripts that use the calibrationSuite library code - -/standalone_scripts: scripts that do not use the calibrationSuite library code - -/tests: tests files, can be ran with 'pytest .' from the root project directory -(Currently only test for the fitFunctions libraryh file is running, more tests are to be added) - - -Current Status: +## Current Status: main branch tag v1.0.0 are the scripts used for the 2/17/24 beamtime - -only changes made are to file organization, and to import statements so work with new organization - -large changes will be merged into ontop of this, but original scripts can be accessed by checking out this tag - -future beamtimes can be tagged as well +* only changes made are to file organization, and to import statements so work with new organization +* large changes will be merged into ontop of this, but original scripts can be accessed by checking out this tag +* future beamtimes can be tagged as well -Developers: +## Developers: -If you are new to git/github, start here: https://confluence.slac.stanford.edu/pages/viewpage.action?pageId=428802060 +If you are new to git/github, start here: [https://confluence.slac.stanford.edu/pages/viewpage.action?pageId=428802060](https://confluence.slac.stanford.edu/pages/viewpage.action?pageId=428802060) -Then read the following for an overview of the development process: https://confluence.slac.stanford.edu/pages/viewpage.action?pageId=429562464 \ No newline at end of file +Then read the following for an overview of the development process: [https://confluence.slac.stanford.edu/pages/viewpage.action?pageId=429562464](https://confluence.slac.stanford.edu/pages/viewpage.action?pageId=429562464) \ No newline at end of file