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.
 
 
 
 
Jérôme Deuchnord 1ffe1ec571 chore: cleanup Makefile and release worlflow 2 years ago
.github chore: cleanup Makefile and release worlflow 2 years ago
.scripts fix: NoneType error on JSON output without position (#199) 3 years ago
_kosmorro fix: return next Moon phase with the correct time zone 2 years ago
manpage feat(event): add support for moon apogee and perigee 3 years ago
.coveragerc ci(compatibility): test on more Python versions and on macOS (#131) 3 years ago
.editorconfig ci(compatibility): test on more Python versions and on macOS (#131) 3 years ago
.gitignore chore: add GitPod config (#201) 3 years ago
.gitpod.yml chore: add GitPod config (#201) 3 years ago
.pylintrc ci(compatibility): test on more Python versions and on macOS (#131) 3 years ago
CHANGELOG.md build: bump version 0.10.6 3 years ago
CODE_OF_CONDUCT.md docs: add code of conduct (#155) 3 years ago
CONTRIBUTING.md chore: add GitPod config (#201) 3 years ago
Dockerfile build: fix Docker image build (#180) 3 years ago
LICENSE.md Add AGPL-v3.0 license 5 years ago
MANIFEST.in feat: use Kosmorrolib (#162) 3 years ago
Makefile chore: cleanup Makefile and release worlflow 2 years ago
Pipfile fix: update Kosmorrolib to version 1.0.1 (#207) 3 years ago
Pipfile.lock chore(deps-dev): bump black from 21.10b0 to 21.11b1 3 years ago
README.md docs: remove Discord from the README 3 years ago
kosmorro feat: use Kosmorrolib (#162) 3 years ago
setup.cfg build: fix Docker image build (#180) 3 years ago
setup.py feat: use Kosmorrolib (#162) 3 years ago

README.md

Kosmorro

Coverage Status Version on PyPI Packaging status Docker Pulls Help translating Kosmorro!

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 and follow the instructions that correspond to your operating system.

Development environment

Before you run Kosmorro in your development environment, check you have installed these programs on your system:

  • Python ≥ 3.7.0 (needed run Kosmorro)
  • PIP3 (needed for package management, usually installed among with Python 3)
  • Pipenv (needed to manage the virtual environment)

Clone this repository and run pipenv sync to install all the dependencies. Then, run Kosmorro by invoking pipenv run python kosmorro.

For comfort, you may want to invoke pipenv shell first and then just python kosmoro.

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 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.

Help translating Kosmorro!

Kosmorro is translated on Weblate, a popular free platform for crowd-sourced internationalization. If you speak a language that is not supported yet, feel free to contribute!

Translation state per language