|
|
|
@@ -1,44 +1,28 @@ |
|
|
|
#  |
|
|
|
[](https://pypi.org/project/kosmorro) [](https://repology.org/project/kosmorro/versions) [](https://hosted.weblate.org/engage/kosmorro/) |
|
|
|
|
|
|
|
A program that calculates your astronomical ephemerides! |
|
|
|
|
|
|
|
[](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) |
|
|
|
Kosmorro is a program that calculates your astronomical ephemerides. |
|
|
|
|
|
|
|
## Installation |
|
|
|
|
|
|
|
### Production environment |
|
|
|
|
|
|
|
If you want to give a try to Kosmorro, head to [its official download page](https://kosmorro.space/cli/download/) and follow the instructions that correspond to your operating system. |
|
|
|
Installing Kosmorro is documented on [the official website](https://kosmorro.space/cli/download/). Just select your operating system and follow the instructions! |
|
|
|
|
|
|
|
### Development environment |
|
|
|
|
|
|
|
Before you run Kosmorro in your development environment, check you have installed these programs on your system: |
|
|
|
|
|
|
|
- Python ≥ 3.8 |
|
|
|
- PIP3 |
|
|
|
- [Poetry](https://python-poetry.org/) |
|
|
|
To contribute to Kosmorrolib, you will need [Poetry](https://python-poetry.org), a software to manage the project from development to publishing. |
|
|
|
|
|
|
|
Clone this repository and run `poetry install` to install all the dependencies. |
|
|
|
Then, run Kosmorro by invoking `poetry run kosmorro`. |
|
|
|
Clone this repository and run `poetry install` to install the dependencies. |
|
|
|
And that's all, your development environment is ready! |
|
|
|
|
|
|
|
For comfort, you may want to invoke `poetry shell` first and then just `kosmorro`. |
|
|
|
To run Kosmorro, invoke `poetry run kosmorro`. For comfort, you may also want to invoke `poetry shell`, which will expose the `kosmorro` command directly. |
|
|
|
|
|
|
|
## Using Kosmorro |
|
|
|
|
|
|
|
Using Kosmorro is as simple as invoking `kosmorro` in your terminal! |
|
|
|
|
|
|
|
By default, it will give you the current Moon phase and, if any, the events that will occur today. |
|
|
|
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). |
|
|
|
|
|
|
|
Kosmorro has a lot of available options. To get a list of them, run `kosmorro --help`, or read its manual with `man kosmorro`. |
|
|
|
|
|
|
|
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). |
|
|
|
|
|
|
|
### Exporting to PDF |
|
|
|
|
|
|
|
Kosmorro can export the computation results to PDF files, but this feature requires first that you install some additional dependencies. |
|
|
|
You can find documentation about this on [Kosmorro's website](https://kosmorro.space/cli/generate-pdf/). |
|
|
|
Kosmorro has a lot of available options to get exactly what you want, including the possibility to get planets rise and set. To get a list of them, run `kosmorro --help`, or read its manual with `man kosmorro`. You can also find usage examples in [the `tldr` manual](https://tldr.sh) with [`tldr kosmorro`](https://tldr.inbrowser.app/pages/common/kosmorro). |
|
|
|
|
|
|
|
## Help translating Kosmorro! |
|
|
|
|
|
|
|
|
