Skip to content

Commit

Permalink
include installation
Browse files Browse the repository at this point in the history
  • Loading branch information
nilshempelmann committed Sep 8, 2018
1 parent a70209f commit 3084432
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 43 deletions.
37 changes: 3 additions & 34 deletions docs/source/admin_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,48 +5,17 @@ Administrator Guidelines

.. contents::
:local:
:depth: 3


.. warning:: WARNING: This section is outdated ...


.. _filesandfolder:

Files and Folders
-----------------

Birdhouse is a framework with several compartments. They can be installed according to the specefic needs of the user. Here is a short overview in order of the most important files and folders:

Environment
...........

Three folder locations have to be pointed out:

* **repository clones:** The fetched code by ``git clone``. It is recommended to store the repositories in ``~/birdhouse``
* **anaconda**: By default, the installation process creates a folder ``~/anaconda`` for general anaconda-specific software.
* **conda environments:** All birds (repositories) are built with their own environment to avoid missmatch of dependencies.
By default, the conda environments are in ``~/.conda/envs/``.

To change the default settings, create a ``Makefile.config`` with::

$ cp Makefile.config.example Makefile.config

and change the paths accordingly to your needs.

Furthermore, in ``environment.yml``, the conda packages can be defined. It is recommended to pin the version. The bird-specific packages are defined here, while in ``requirements/conda_pinned``, general versions are set.

There are **log files** situated at:: ``~/birdhouse/var/log/pywps/``

:depth: 2


.. warning:: WARNING: This section is outdated ...

.. _birdhouse_ecosystem:

Set up a birdhouse ecosystem server
-----------------------------------

If you are already familliar with installing single standalone WPS (follow the installation guides in the documentations of e.g. emu), then you are ready to set up a birdhouse containing flyingpigeon (providing scientific analyses methods), malleefowl (to search and fetch data) and the pheonix (a graphic interface for a web browser including a WMS).
If you are already familiar with installing single standalone WPS (follow the :ref:`installation` guides in the documentations of e.g. emu), then you are ready to set up a birdhouse containing flyingpigeon (providing scientific analyses methods), malleefowl (to search and fetch data) and the pheonix (a graphic interface for a web browser including a WMS).

general remarks:
..................
Expand Down
31 changes: 31 additions & 0 deletions docs/source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,36 @@ Many climate analysis operations are implemented using OpenClimateGIS_.
You can find the source code of all birdhouse components on GitHub_.
Docker images with birdhouse components are on `Docker Hub`_


.. _filesandfolder:

Files and Folders
-----------------

.. Warning: outdated
The birds have a similar folder structure. While library dependencies are stored within the conda deployment


Three folder locations have to be pointed out:

* **repository clones:** The fetched code by ``git clone``. It is recommended to store the repositories in ``~/birdhouse``
* **anaconda**: By default, the installation process creates a folder ``~/anaconda`` for general anaconda-specific software.
* **conda environments:** All birds (repositories) are built with their own environment to avoid missmatch of dependencies.
By default, the conda environments are in ``~/.conda/envs/``.

To change the default settings, create a ``Makefile.config`` with::

$ cp Makefile.config.example Makefile.config

and change the paths accordingly to your needs.

Furthermore, in ``environment.yml``, the conda packages can be defined. It is recommended to pin the version. The bird-specific packages are defined here, while in ``requirements/conda_pinned``, general versions are set.

There are **log files** situated at:: ``~/birdhouse/var/log/pywps/``




.. _GitHub: https://github.com/bird-house
.. _`Docker Hub`: https://hub.docker.com/r/birdhouse
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

overview
architecture
installation
admin_guide
dev_guide
communication
Expand Down
6 changes: 4 additions & 2 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
.. _installation:

Installation
============
Installation Guidelines
=======================

.. contents::
:local:
:depth: 2

.. warning:: WARNING: This section is outdated ...

Birdhouse consists of several components like Malleefowl_ and Emu_. Each of them can be installed individually.
The installation is done using the Python-based build system :term:`Buildout`.
Most of the dependencies are maintained in the :term:`Anaconda Python distribution`.
Expand Down
7 changes: 0 additions & 7 deletions docs/source/snippetstobesorted.rst

This file was deleted.

0 comments on commit 3084432

Please sign in to comment.