Update readme

[mathomp4]

Summary by CodeRabbit

• New Features
  • Introduced new BLAS options, including blis.
  • Added micromamba and mamba as installation options.
• Changes
  • Updated the default installer to micromamba for Linux and macOS.
  • Changed default BLAS to accelerate on macOS and MKL on Linux.
  • Installation paths now include the current date.

[coderabbitai]

Walkthrough

The recent update introduces enhancements and changes to the installation process, focusing on flexibility and optimization. It adds options for BLAS libraries, including blis, and introduces micromamba and mamba as new installer options. Notably, micromamba becomes the default installer for Linux and macOS. The default BLAS library has been updated to accelerate for macOS and MKL for Linux. Additionally, the installation path has been revised to reflect the current date.

Changes

File(s)	Change Summary
README.md	- Added BLAS options including blis. - Added new installer options: micromamba and mamba. - Changed default installer to micromamba for Linux and macOS. - Updated default BLAS to accelerate (macOS) and MKL (Linux). - Updated the installation path to include the current date.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 913ec3e and a53e4b5.

Files selected for processing (1)

• README.md (2 hunks)

Additional comments: 4

README.md (4)

• 37-38: The addition of blis as an option for the BLAS library and the introduction of micromamba as a default installer are significant improvements. These changes align with the PR objectives to provide users with more flexibility and efficient tools for installation. However, it's important to ensure that the documentation clearly explains the benefits or use cases for each BLAS option and installer to help users make informed decisions.

Ensure that the documentation elsewhere in the project or in linked resources provides adequate information on when to choose each BLAS option or installer.

• 39-39: Introducing mamba as an alternative installer alongside micromamba and conda offers users a broader range of choices. It's crucial, however, to highlight the differences and recommend scenarios for using each installer to aid users in selecting the most suitable option for their needs.

Verify if additional documentation or tutorials are available for users unfamiliar with these installers, and consider linking to them from the README.

• 43-44: The decision to use micromamba by default on both Linux and macOS, and to specify accelerate for macOS and MKL for Linux as the default BLAS libraries, is a strategic choice that likely optimizes performance for the majority of users. It's essential to ensure that this information is prominently highlighted in the documentation so that users are aware of these defaults and can adjust their installations if necessary.

Confirm that the installation scripts and any associated automation correctly implement these defaults and that there are clear instructions for users who wish to choose different options.

• 55-55: Updating the installation path to include the current date is a thoughtful change that helps prevent overwriting previous installations. This approach enhances the maintainability of installations and allows for easier rollback or comparison between different versions. Ensure that this change is clearly communicated in the installation instructions to avoid confusion among users.

Check if there are any scripts or tools that rely on a static installation path and update them accordingly to accommodate this change.