You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.9 KiB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. # ![Kosmorro](kosmorrolib/assets/png/kosmorro-logo.png)
  2. [![codecov](https://codecov.io/gh/Deuchnord/kosmorro/branch/master/graph/badge.svg)](https://codecov.io/gh/Deuchnord/kosmorro) [![Version on PyPI](https://img.shields.io/pypi/v/kosmorro)](https://pypi.org/project/kosmorro) [![Discord](https://img.shields.io/discord/650237632533757965?logo=discord&label=%23kosmorro)](https://discord.gg/nyemBqE)
  3. ## About the project
  4. Kosmorro is a software that allows you to compute the ephemeris for a date, a month or a year.
  5. ## Installation
  6. ### Requirements
  7. Kosmorro requires the following software to work:
  8. - Python ≥ 3.5.0
  9. - PIP
  10. ### Production environment
  11. Keep in mind that Kosmorro is still in alpha development stage and is not considered as stable.
  12. #### Linux
  13. ##### Arch Linux, Manjaro…
  14. Kosmorro is available [in the AUR](https://aur.archlinux.org/packages/kosmorro).
  15. ##### Other distributions
  16. Kosmorro is available [on PyPI](https://pypi.org/project/kosmorro/), a repository dedicated to Python.
  17. First, install `python-pip` on your system and invoke the following command: `pip install kosmorro`.
  18. #### macOS
  19. Currently, macOS does not provide Python 3, so you will first have to install it.
  20. If you don't have it, first install [HomeBrew](https://formulae.brew.sh), then install Python 3: `brew install python`.
  21. This will install Python 3 and its PIP on your system. Note that their executables are called `python3` and `pip3`.
  22. Now, you can install Kosmorro with your PIP: `pip3 install kosmorro`.
  23. #### Windows
  24. Kosmorro being at an early-stage development, Windows is not supported officially for now.
  25. ### Development environment
  26. First, install [Pipenv](https://pypi.org/project/pipenv/).
  27. Clone this repository and run `pipenv sync` to install all the dependencies.
  28. Then, run Kosmorro by invoking `pipenv run python kosmorro`.
  29. For comfort, you may want to invoke `pipenv shell` first and then just `python kosmoro`.
  30. ## Using Kosmorro
  31. Using Kosmorro is as simple as invoking `kosmorro` in your terminal!
  32. By default, it will give you the current Moon phase and, if any, the events that will occur today.
  33. To get the rise, culmination and set of the objects of the Solar system, you will need to give it your position on Earth: get your current coordinates (with [OpenStreetMap](https://www.openstreetmap.org) for instance), and give them to Kosmorro by invoking it with the following parameters: `--latitude=X --longitude=Y` (replace `X` by the latitude and `Y` by the longitude).
  34. Kosmorro has a lot of available options. To get a list of them, run `kosmorro --help`, or read its manual with `man kosmorro`.
  35. Note: the first time it runs, Kosmorro will download some important files needed to make the computations. They are stored in a cache folder named `.kosmorro-cache` located in your home directory (`/home/<username>` on Linux, `/Users/<username>` on macOS).
  36. ### Exporting to PDF
  37. Kosmorro can export the computation results to PDF files, but this feature requires first that you install some additional dependencies. Before you use this feature, please check these packages are installed:
  38. - **A LaTeX distribution:**
  39. - Linux: install TeXLive through your packages manager. Kosmorro just needs the minimal installation, you don't need any extension.
  40. - macOS: install [MacTeX](https://www.tug.org/mactex/), the basic version will suffice:
  41. - from the official website, choose the _smaller download_
  42. - with Brew: `brew install basictex`
  43. - **The `latex` Python library:**
  44. - Arch Linux: the library is available [on the AUR](https://aur.archlinux.org/packages/python-latex)
  45. - Any other systems: install it through PyPI: `pip install latex`
  46. These dependencies are not installed by default, because they take a lot of place and are not necessary if you are not interested in generating PDF files.
  47. The first time you ask Kosmorro to create a PDF, it may be a little verbose. You can ignore its blahblah.