QuartzMap/docs/source/install.rst

60 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2024-07-10 16:27:23 +00:00
Install
=====
.. _installation:
2024-07-10 20:20:22 +00:00
Installers
2024-07-10 16:27:23 +00:00
------------
2024-07-10 20:20:22 +00:00
If you plan to use SSL, be sure to set the hostname
2024-07-10 16:27:23 +00:00
.. code-block:: console
2024-07-10 20:20:22 +00:00
$ hostnamectl set-hostname qpod.webgis1.com
Installer scripts are available in the install directory and should be called from the base directory.
Download QuartzMap or use Git.
Change to the quartzmap directory
.. code-block:: console
$ git clone https://github.com/AcuGIS/quartzmap.git
2024-07-10 16:27:23 +00:00
$ cd quartzmap
2024-07-10 20:20:22 +00:00
If PostgreSQL is not installed, install it using /installer/postgres.sh
.. code-block:: console
$ ./installer/postgres.sh
Run the installer:
.. code-block:: console
$ ./installer/app-install.sh
Manual Installation
-------------------
2024-07-10 16:27:23 +00:00
To retrieve a list of random ingredients,
you can use the ``lumache.get_random_ingredients()`` function:
.. autofunction:: lumache.get_random_ingredients
The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
will raise an exception.
.. autoexception:: lumache.InvalidKindError
For example:
>>> import lumache
>>> lumache.get_random_ingredients()
['shells', 'gorgonzola', 'parsley']