Jérôme Deuchnord
889d957532
|
5 years ago | |
|---|---|---|
| .dependabot | 5 years ago | |
| .github | 5 years ago | |
| assets | 5 years ago | |
| kosmorrolib | 5 years ago | |
| test | 5 years ago | |
| .coveragerc | 5 years ago | |
| .gitignore | 5 years ago | |
| .pylintrc | 5 years ago | |
| CHANGELOG.md | 5 years ago | |
| CONTRIBUTING.md | 5 years ago | |
| LICENSE.md | 5 years ago | |
| Pipfile | 5 years ago | |
| Pipfile.lock | 5 years ago | |
| README.md | 5 years ago | |
| commitlint.config.js | 5 years ago | |
| kosmorro | 5 years ago | |
| setup.py | 5 years ago | |
README.md
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).