Page not found
+ +Sorry, it looks like you have tried to reach a page that does not exist.
+If you were following a link, then it might be broken. Feel free to report it on GitHub.
+ +diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..82cdce3c --- /dev/null +++ b/404.html @@ -0,0 +1,90 @@ + + +
+ +Sorry, it looks like you have tried to reach a page that does not exist.
+If you were following a link, then it might be broken. Feel free to report it on GitHub.
+ +This page lists all the changes that have been made on each version of Kosmorro.
+Looking for information about how long the versions of Kosmorro are supported? Check this page.
+This version is empty and contains exactly the same things as v0.10.3. +It has been created because of a manipulation mistake that led to the creation of a wrong version on PyPI.
+If v0.10.3 does not exist on your distribution, install v0.10.4, and you will have exactly the same thing.
+$HOME/.kosmorro-cache
texlive-latex-extra
package is needed to generate the PDF outputEvent
and MoonPhase
classes have been dropped in favor of enum.Enum
's name
and value
properties.Kosmorro is available in your official repositories!
+You can install it directly with your package manager:
+pkg install kosmorro
+
+
+
+The simplest command you can run is kosmorro
.
+If you need help in using Kosmorro, you have different options depending on your preference:
kosmorro --help
gives you the complete synopsis of the program, with its optionsman kosmorro
tldr
manual with tldr kosmorro
If you want to generate a PDF file, you might want to look at its dedicated documentation too.
+ +Select your operating system:
+Or you can build the program from the sources.
+Kosmorro is available on the AUR! To install it, use your favorite AUR helper:
+yay kosmorro
+
+For other distributions, the recommended way to install Kosmorro is using pipx
:
pipx install kosmorro
+
+
+
+The simplest command you can run is kosmorro
.
+If you need help in using Kosmorro, you have different options depending on your preference:
kosmorro --help
gives you the complete synopsis of the program, with its optionsman kosmorro
tldr
manual with tldr kosmorro
If you want to generate a PDF file, you might want to look at its dedicated documentation too.
+ +Kosmorro is available in its own Tap. First, you will have to tell Homebrew to subscribe to it:
+brew tap kosmorro/tap
+
+Now, you can install Kosmorro like any other package:
+brew install kosmorro
+
+pipx
macOS may not have the last version of Python. The best and simplest method to install it is with Homebrew:
+brew install python
+
+Then, use pipx
to install Kosmorro:
pipx install kosmorro
+
+
+
+The simplest command you can run is kosmorro
.
+If you need help in using Kosmorro, you have different options depending on your preference:
kosmorro --help
gives you the complete synopsis of the program, with its optionsman kosmorro
tldr
manual with tldr kosmorro
If you want to generate a PDF file, you might want to look at its dedicated documentation too.
+ +Building from the sources require:
+make
commandwheel
(needed to create the Python installable package)Babel
(to compile the translations)All the sources are available on GitHub. If you prefer to build it from sources, clone the repository and check the tag of your choice out. Then compile the translations and the final package with the i18n
and build
recipes from the Makefile:
git clone https://github.com/Kosmorro/kosmorro && cd kosmorro
+git checkout vx.y.z # replace "x.y.z" with the version
+make i18n build
+
+Kosmorro is a free (as in freedom) software, anyone can contribute to enhance Kosmorro.
+Read the contribution guide on GitHub to get started!
+ +Kosmorro can export the computation results to PDF files that you can use for your obervation nights. +The PDF generator uses LaTeX, a language designed for high-quality documents composition. +This page explains how to use it.
+Before you use Kosmorro's PDF generator, you will need to install a TeXLive distribution software:
+texlive
and the texlive-latex-extra
packages from your distribution's repository.texlive-core
and texlive-bin
packages from your extra repositories.PDF=on
option.brew install basictex
The PDF generator can be used simply by adding the following arguments to any Kosmorro command:
+--format=pdf
: tells Kosmorro you want a PDF export--output={path}
: tells Kosmorro where to save the PDF fileFor instance, if you want to save a PDF file in $HOME/Documents/observation_night.pdf
with the computation results for tomorrow in Lille, France, invoke the following command:
kosmorro \
+ --date=+1d \
+ --latitude=50.5824 \
+ --longitude=3.0624 \
+ --format=pdf \
+ --output=$HOME/Documents/observation_night.pdf
+
+Note that you can optionaly disable the graph generation with the --no-graph
argument if you don't want it.
+In this case, the ephemerides will be output in a simple table.
If the observation coordinates are missing, the PDF document will not contain the ephemerides section.
+Kosmorro uses the pdflatex
command to generate the PDF document.
Check that you have installed TeXLive as explained in this page, and that the pdflatex
command is in your $PATH
:
which pdflatex
. If you are getting a not found error, it means that TeXLive is not in your $PATH
. Read your OS distribution's manual to fix this.pdflatex dumb.tex
If the test PDF file is correctly generated, but you still cannot generate a PDF file, you are most likely facing a bug. +Please consider opening an issue on GitHub, so we can investigate it.
+ +Click here to be redirected.
diff --git a/cli/manpage/index.html b/cli/manpage/index.html new file mode 100644 index 00000000..5059911b --- /dev/null +++ b/cli/manpage/index.html @@ -0,0 +1,172 @@ + + + + +Below is the man page for the command line program.
+You can also get it directly in your terminal on Linux, macOS and FreeBSD with the man kosmorro
command.
Looking for some usage examples? Take a look at the tldr
page!
kosmorro
kosmorro
[OPTIONS]...-h
, --help
+show a help message and exit
--version
, -v
+show the program version
--clear-cache
+delete all the files Kosmorro stored in the cache
--latitude=
LATITUDE, -lat
LATITUDE
+the observer's latitude on Earth
--longitude=
LONGITUDE, -lon
LONGITUDE
+the observer's longitude on Earth
--date=
DATE, -d
DATE
+The date for which the ephemerides must be computed, either in the YYYY-MM-DD format or as an interval in the "[+-]YyMmDd" format (with Y, M, and D numbers); defaults to the current date
--timezone=
TIMEZONE, -t
TIMEZONE
+the timezone to display the hours in; e.g. 2 for UTC+2 or -3 for UTC-3
--no-colors
+disable the colors in the console
--output=
OUTPUT, -o
OUTPUT
+a file to export the output to; if not given, the standard output is used
--format=
FORMAT, -f
FORMAT
+the format under which the information have to be output; one of the following: text, json, pdf
--no-graph
+present the ephemerides in a table instead of a graph; PDF output format only
The environment variable listed below may be used instead of the options.
+The options have a higher priority than the environment variable.
+As a consequence, any option that would be given to kosmorro
will override its corresponding environment variable.
Available environment variables are:
+KOSMORRO_LATITUDE
+the observer's latitude on Earth (alternative to --latitude
)
KOSMORRO_LONGITUDE
+the observer's longitude on Earth (alternative to --longitude
)
KOSMORRO_TIMEZONE
+the observer's timezone (alternative to --timezone
)
Compute the events only for the current date:
+kosmorro
+
+Compute the ephemerides for Lille, France, on April 1st, 2022:
+kosmorro --latitude=50.5876 --longitude=3.0624 --date=2022-04-01
+
+Compute the ephemerides for Lille, France, on April 1st, 2022, and export them in a PDF document:
+kosmorro --latitude=50.5876 --longitude=3.0624 -date=2022-04-01 --format=pdf --output=file.pdf
+
+Written by Jérôme Deuchnord.
+Please report any encountered bugs on Kosmorro's GitHub project.
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ +