Cyclophaser

Bug fixes

- **determine_periods.py**: reverted threshold_intensification_length back to 7.5%

Bug fixes

- **determine_periods.py**: fixed wrong imports
- **find_stages.py**: fixed not finding residual period when the gap between stages is too large - was not really fixed on last update

Bug fixes

- **determine_periods.py**: fixed not finding residual period when the gap between stages is too large

Modified

- **determine_periods.py**: thresholds for phase determination can be passed as optional arguments by the user
- **find_stages.py**: added arguments for passing the thresholds for phase determination
-- **plots.py**: used custom arguments from phase determination for plotting

Bug fixes

- Wrong imports on scripts

Modified

- **README.md**: Updated to focus on directing users to the Read the Docs for usage and documentation. Simplified to enhance readability and direct users to comprehensive documentation online.
- **setup.py**: Included badges for download statistics and build status. The long description is now dynamically sourced from the README file to maintain consistency across platforms.
- **api.rst**: Added detailed information about the package's API, providing users with a clear understanding of available functionalities and usage.
- **installation.rst**: Updated to guide users for installation via pip, simplifying the installation process.
- **usage.rst**: Expanded to include detailed examples and more comprehensive documentation, offering users practical guidance and improved understanding of the package's capabilities.

These updates aim to enhance the user experience by providing clearer, more accessible documentation and a streamlined setup process.

Added

- Documentation requirements text file