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 bea675f5fd
build: bump v0.3.1
5 jaren geleden
.dependabot chore: add Dependabot config 5 jaren geleden
.github chore: add BC-break line to the PR template 5 jaren geleden
assets Enhance logo 5 jaren geleden
kosmorrolib build: bump v0.3.1 5 jaren geleden
test fix(moonphase): fix the Moon phase prediction 5 jaren geleden
.coveragerc test(coverage): add codecov 5 jaren geleden
.gitignore chore(gitignore): add NPM's specific files to .gitignore 5 jaren geleden
.pylintrc Refactorization of the computation functions 5 jaren geleden
CHANGELOG.md build: bump v0.3.1 5 jaren geleden
CONTRIBUTING.md docs(contributing): add contribution guide 5 jaren geleden
LICENSE.md Add AGPL-v3.0 license 5 jaren geleden
Pipfile test(coverage): add codecov 5 jaren geleden
Pipfile.lock test(coverage): add codecov 5 jaren geleden
README.md ci: remove lgtm 5 jaren geleden
commitlint.config.js build: add commitlint configuration 5 jaren geleden
kosmorro fix(position): remove useless altitude argument 5 jaren geleden
setup.py chore: update setup.py 5 jaren geleden

README.md

Kosmorro

codecov Version on PyPI

About the project

Kosmorro is a software that allows you to compute the ephemeris for a date, a month or a year.

Installation

Requirements

Kosmorro requires the following software to work:

  • Python ≥ 3.5.0
  • PIP

Production environment

Keep in mind that Kosmorro is still in alpha development stage and is not considered as stable.

Linux

Arch Linux, Manjaro…

Kosmorro is available in the AUR.

Other distributions

Kosmorro is available on PyPI, a repository dedicated to Python. First, install python-pip on your system and invoke the following command: pip install kosmorro.

macOS

Currently, macOS does not provide Python 3, so you will first have to install it. If you don’t have it, first install HomeBrew, then install Python 3: brew install python.

This will install Python 3 and its PIP on your system. Note that their executables are called python3 and pip3. Now, you can install Kosmorro with your PIP: pip3 install kosmorro.

Windows

Kosmorro being at an early-stage development, Windows is not supported officially for now.

Development environment

First, install Pipenv.

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.

Running Kosmorro

Using Kosmorro is as simple as invoking kosmorro in your terminal!

By default, it will compute and display the ephemerides for the current day, for the cordinates (0;0). To set your position on Earth, get your 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.

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