Commit dd83b09a authored by Francesco Montanari's avatar Francesco Montanari

Merge branch 'devel'

* devel:
  Update README
  Update README
  Update inline README
  Update package commentary
parents f0e04b23 cd0f1cd8
......@@ -54,8 +54,14 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
** MELPA
The package is available on the [[https://melpa.org/][MELPA]] repository. Please
follow the related installation instructions.
The package is available on the [[https://melpa.org/][MELPA]] repository. Enable the
repository following the related instructions, then type:
#+BEGIN_EXAMPLE
M-x package-list-packages
#+END_EXAMPLE
Select the =cosmo= package for installation.
** Manual installation
......@@ -155,12 +161,16 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
* Contributing
Please see [[http://orgmode.org/worg/org-contribute.html#patches][this page]] for a good example of patches
contributions.
Any kind of contribution is welcome.
For small contributions simple patches are welcome (the
preferred way is to follow, e.g., [[http://orgmode.org/worg/org-contribute.html#patches][org-mode conventions]]). For
more substantial contributions the following workflow may be
considered:
More substantial contributions should proceed through git
[[https://git-scm.com/book/en/v2/Distributed-Git-Distributed-Workflows][Integration-Manager Workflow]]. In short: fork the repository, do
the changes on a new branch (the master branch should only be
used to pull updates from the original git remote onto your
personal repository) and notify via the issue tracker or email
about the modifications.
- Fork the repository.
- Do the changes on a new branch (the master branch should only
be used to pull updates from the original repository, added
as a git remote).
- Notify via the issue tracker or email about the modifications
(please provide the git address and branch name to be merged).
......@@ -26,27 +26,31 @@
;;; Commentary:
;; This package provides a cosmological calculator for Lambda-CDM
;; models. Such a framework describes a homogeneous and isotropic
;; universe containing a cosmological constant (Lambda) and a Cold
;; Dark Matter (CDM) component, besides ordinary species. The
;; model is characterized by the following parameters:
;; Cosmological calculator for Lambda-CDM models.
;;
;; - H_0 :: Hubble parameter (expansion rate) today.
;; - Omega_m0 :: Matter density parameter today.
;; - Omega_Lambda :: Cosmological constant density parameter.
;; - Omega_r0 :: Relativistic species (e.g., photons plus
;; neutrinos) density parameter today.
;; - Omega_k0 :: Curvature density parameter today. This
;; parameter is derived from the others above
;; according to Friedmann's equation
;; Omega_m0 + Omega_Lambda + Omega_r0 + Omega_k0 = 1.
;; The package provides interactive commands for handy computation of
;; cosmological distance measures. For instance, to display a summary
;; table, type:
;;
;; All cosmological quantities are computed at a given redshift
;; value:
;; M-x cosmo-calculator
;;
;; - redshift :: Gravitational redshift of photons frequency due to the
;; expansion of the Universe.
;; All cosmological quantities are computed at a given value of the
;; gravitational `redshift' of photons frequency due to the expansion
;; of the Universe.
;;
;; To set the cosmological parameters, type:
;;
;; M-x cosmo-set-params
;;
;; The Lambda-CDM model is characterized by the following parameters:
;;
;; - `H0': Hubble parameter (expansion rate) today (e.g., 70 km/s/Mpc).
;; - `omatter': Matter density parameter today (e.g., 0.3).
;; - `olambda': Cosmological constant density parameter (e.g., 0.7).
;; - `orel': Relativistic species density parameter today (e.g., 0.0001).
;;
;; The curvature density parameter today is derived from the others
;; above according to Friedmann's equation.
;;
;; Definitions follow Hogg (1999)
;; <https://arxiv.org/abs/astro-ph/9905116>.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment