Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 2.28 KB

README.md

File metadata and controls

39 lines (28 loc) · 2.28 KB

Documentation Status pytest flake8 codecov status

Welcome to Eureka!

ALERT: Project Eureka! is currently under heavy development. Please understand that you are likely to encounter bugs at this point and know that the code will become more stable with time. Use at your own risk.

Installation

Up-to-date installation instructions can be found at https://eurekadocs.readthedocs.io/en/latest/installation.html.

Quickstart

Once Eureka! has been installed, you can learn how to use some aspects of the package using our quickstart guide.

Issues and FAQ

If you experience an issue when installing or using Eureka!, first check out our FAQ page. If the answer to your question is not there, try looking searching for an open or closed issue on GitHub. If you still can't find the solution to your issue, please open a new issue on GitHub at GitHub and leave as many details about your issue/error as you can, such as your operating system version, your conda version, your python version, the version of Eureka! you are using, and as many details about how we can reproduce the error you encountered.

Documentation

Check out the rest of the Eureka! documentation at https://eurekadocs.readthedocs.io.