Welcome to AstrOmakase’s Documentation!#
AstrOmakase is an optimised Ubuntu 24.04 setup specifically designed for astronomers and astrophysicists. It builds on the foundation of the Omakub project, offering a curated and comprehensive environment that includes all the essential tools needed for astronomical research and development.
What is AstrOmakase?#
AstrOmakase is more than just a collection of software. It is a thoughtfully crafted setup tailored to streamline your research workflow.
The name “AstrOmakase” combines “astronomy” with the Japanese word “omakase,” which means “I’ll leave it up to you.” Just as in an omakase dining experience, where the chef selects and prepares a personalized meal, AstrOmakase provides a tailored software environment, allowing you to focus on your research without worrying about configuring each tool individually.
Note
AstrOmakase is inspired by the Omakub project. Ww wanto to express our gratitude to the Omakub team for their excellent work and for providing a solid foundation for AstrOmakase.
Installation#
AstrOmakase simplifies the setup process, enabling you to focus on your research and development tasks without the hassle of manual configuration.
Run the following script to install AstrOmakase on your Ubuntu 24.04 system:
wget -qO- https://mug-n-ai.github.io/AstrOmakase/installer.sh | bash
How to Use#
To learn how to use this setting, please refer to the Menu section below to learn about the tools included in AstrOmakase. The tools are organised into categories for easy navigation and access.
If you want to learn about the keybinds, shortcuts and gestures, please refer to the Keybindings section below.
How to Update#
AstrOmakase can be easily updated from the dedicated executable:
The app also shows the installed version. The user can launch the application from console running astromakase, or with the dedicated launcher.
Contributing to AstrOmakase#
We warmly welcome contributions to AstrOmakase! Whether you’re fixing bugs, adding new features, or improving the documentation, your efforts help us build a better tool for the astronomy community. Here are the steps to follow if you’d like to contribute:
Fork the repository: Start by forking the AstrOmakase repository to your own GitHub account.
Create a new branch: Create a branch for your new feature or bug fix. This ensures that your changes remain isolated from the main branch.
git checkout -b feature/your-feature-name
Make your changes: Add or modify the code as necessary. Ensure that your changes are well-tested and documented.
Commit your changes: Once you’re satisfied with your changes, commit them with a clear and descriptive message.
git commit -m 'Add feature: your feature name'
Push your branch: Push the branch to your forked repository.
git push origin feature/your-feature-name
Open a Pull Request: Finally, submit a Pull Request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests>_ to the main AstrOmakase repository. Please include a description of your changes, any relevant issues your code addresses, and any tests you’ve written.
We will review your Pull Request as soon as possible, and once approved, it will be merged into the main branch!
Thank you for your contribution to AstrOmakase—together we can build an even better tool for the astronomical research community!