<commit_before>###############
Getting Started
###############

Introduction
============

Welcome to the **Arches Installation Guide**. This document is intended
to help you quickly get Arches running on your server.

What do I need to know to use this guide?
-----------------------------------------

Arches is designed to let you build semantically rich, geospatial applications.  If you are a software developer, this document will help you understand how to use Arches to create your own custom applications.  We expect that you are comfortable with python and javascript.

If you're not a software developer, you'll find useful information in this document such as how to install Arches and how to understand the graph model Arches uses to manage data.

Please note that you will need to install an Arches application to do any real work with Arches.  You can visit http://www.archesproject.org to get a list of open source Arches applications.  


It's important to recognize that Arches is designed to manage large, enterprise-scale datasets. The software is sophisticated and is designed to support extensive customization.  This means that there are many ways to deploy Arches.

We've written this guide to streamline the installation of Arches Server in the most straight-forward manner possible. However, you can access the Arches source code at https://bitbucket.org/arches/arches3 if you wish to extend or contribute to the Arches project.



System Requirements
===================

There are a few things to know about Arches before we get started.

Please note that Arches has been developed for modern browsers. It supports:

    * Firefox
    * Chrome
    * Safari
    * Opera
    * Internet Explorer 10 or higher.

Minimum system requirements:

    * At least 4GB of RAM for evaluation and testing, or 8 to 16GB for production.
    * 10GB minimum to install the code base and test dataset, but disk space requirements will vary greatly depending on the size of your dataset



Dependencies
============

* PostgreSQL relational database (version 9.3)
* PostGIS (version 2.x) spatial module for PostgreSQL
* Python (version 2.7.6 - there seem to be issues with later versions of python) 
* GEOS

These instructions will provide some guidance on installing 
the required dependencies and getting Arches up and running quickly.


.. toctree::
   :maxdepth: 1

   installing-dependencies-linux
   installing-dependencies-windows


Installing Arches
=================

For the installation process you will need **pip** installed on your system. If you don't already have it, you can find instructions to install it here: https://pip.pypa.io/en/latest/installing.html

If you have installed the dependencies, you're ready to install Arches.

#1. Create the Arches Project folder:

    Create a folder called 'Projects' (or some other meaningful name) on your system.    


#2.  Install virtualenv:
    
    Open a command prompt and type::

        $ pip install virtualenv

    .. note::
        For Linux users: Using apt-get to install virtualenv will install an older version that will result in errors in your Arches installation. Be sure to use pip for your virtualenv installation.

    virtualenv creates a directory with it's own installation of Python and Python executables. 

#3. Create the ENV folder:

    Navigate to your Projects directory (or wherever you named the root Arches folder) and create your virtual environment with the following command::

        $ virtualenv ENV

    
#4. Install Arches:

    Activate your virtual environment with the following command:
<commit_msg>specified the version of virtualenv to use because of issues running the arches-app command with more recent versions on linux.<commit_after>###############
Getting Started
###############

Introduction
============

Welcome to the **Arches Installation Guide**. This document is intended
to help you quickly get Arches running on your server.

What do I need to know to use this guide?
-----------------------------------------

Arches is designed to let you build semantically rich, geospatial applications.  If you are a software developer, this document will help you understand how to use Arches to create your own custom applications.  We expect that you are comfortable with python and javascript.

If you're not a software developer, you'll find useful information in this document such as how to install Arches and how to understand the graph model Arches uses to manage data.

Please note that you will need to install an Arches application to do any real work with Arches.  You can visit http://www.archesproject.org to get a list of open source Arches applications.  


It's important to recognize that Arches is designed to manage large, enterprise-scale datasets. The software is sophisticated and is designed to support extensive customization.  This means that there are many ways to deploy Arches.

We've written this guide to streamline the installation of Arches Server in the most straight-forward manner possible. However, you can access the Arches source code at https://bitbucket.org/arches/arches3 if you wish to extend or contribute to the Arches project.



System Requirements
===================

There are a few things to know about Arches before we get started.

Please note that Arches has been developed for modern browsers. It supports:

    * Firefox
    * Chrome
    * Safari
    * Opera
    * Internet Explorer 10 or higher.

Minimum system requirements:

    * At least 4GB of RAM for evaluation and testing, or 8 to 16GB for production.
    * 10GB minimum to install the code base and test dataset, but disk space requirements will vary greatly depending on the size of your dataset



Dependencies
============

* PostgreSQL relational database (version 9.3)
* PostGIS (version 2.x) spatial module for PostgreSQL
* Python (version 2.7.6 - there seem to be issues with later versions of python) 
* GEOS

These instructions will provide some guidance on installing 
the required dependencies and getting Arches up and running quickly.


.. toctree::
   :maxdepth: 1

   installing-dependencies-linux
   installing-dependencies-windows


Installing Arches
=================

For the installation process you will need **pip** installed on your system. If you don't already have it, you can find instructions to install it here: https://pip.pypa.io/en/latest/installing.html

If you have installed the dependencies, you're ready to install Arches.

#1. Create the Arches Project folder:

    Create a folder called 'Projects' (or some other meaningful name) on your system.    


#2.  Install virtualenv:
    
    Open a command prompt and type::

        $ pip install virtualenv==1.11.4

    virtualenv creates a directory with it's own installation of Python and Python executables. 

#3. Create the ENV folder:

    Navigate to your Projects directory (or wherever you named the root Arches folder) and create your virtual environment with the following command::

        $ virtualenv ENV

    
#4. Install Arches:

    Activate your virtual environment with the following command:

{'fraction_non_alphanumeric': 0.07566204287515763, 'fraction_numerical': 0.006165055345383214, 'mean_word_length': 3.7240238252812707, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2816096', 'n_tokens_mistral': 1780, 'n_tokens_neox': 1650, 'n_words': 977}