THESE TOOLS ARE IN VARIOUS STAGES OF DEVELOPMENT! You are welcome to submit pull requests for any improvements you make.
Various tools to support high level application development at LCLS using python. This is an effort to maintain a single repo that can be referenced for developemnt. These are not polished tools, they still need a lot of work, so please keep that in mind.
Python tools for LCLS:
- Device API (profile monitors, SC cavities, stoppers, magnets, etc...)
- SLAC Logger
- Custom Math Tools
- Image Processing Tools
- Beam calculations (emittance, solenoid alignment corrections, etc...)
- Make your code readable (pulling apart syntax can be painful)
- Add comments whenever possible
- Try your best to adhere to style guidelines set forth in PEP8
- Try to be idiomatic, there is a reason people spent time writing these guides.
- Add tests (unittest is used currently, please use unit tests at a bare minimum)
- Focus on extensibility (don't put a bunch of modules/classes into one file or directory and make them reference each other, if you can avoid it)
- Try to understand the purpose of each tool and do not overcomplicate with business logic that can live in an application. These should be small and useful tools/apis with well understood and firm contracts between the api and the user
- Bonus: If you do all of the above in general, you will be a much better coder
Python 2 is no longer supported. Please write all new modules in Python 3.7 or above.
- Upgrade all main code to python 3.7 or above.
- Use mocks in unittest once we have upgraded
- Update style for everything python3, including asyncio, generators/yield, import changes, etc...
- Actually verify a requirements.txt file covers all dependencies
- Create a CLI tool
- Provide example application using lcls_tools
- Add more examples
- Document with sphinx or mkdocs (resolve doc branch PR)
- Make a robust and somewhat flexible logger module that knows about SLAC things, current logger is very basic