load-capacitor-assistant

Load Capacitor Assistant

Assists in picking out appropriate load capacitors for MHz or kHz pierce oscillator circuits.
Request Feature

Table of Contents

1. About The Project
2. Necessary Tools
3. Getting Started
4. Usage
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This tool was created to make the life of board design engineers a bit easier when it comes time to couple a crystal to an IC. This program helps ensure that the gain margin (safety factor) and frequency tolerance of the crystal is within the project's constraints.

Why:

• A lot of the math is lifted off your shoulders
• It takes the guesswork out of the equation

The main thing that's needed for this program is the crystal parameters taken from the datasheet along with the current frequency read out by a buffered output from the board.

Necessary tools

• Jupyter Notebook

Getting Started

Once Jupyter Notebook is installed, please run the command below within the directory.

Usage

This is an example of how to list things you need to use the software and how to install them. This will launch the program in your primary browser.

jupyter notebook cl-vs-frequency.ipynb

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Ryan Thompson - @rthomp10 - [email protected]

Project Link: https://github.com/rthomp10/load-capacitor-assistant

Acknowledgements

• NumPy
• MatplotLib